wiki/conf.py at master · polyzen/wiki · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

from importlib.util import find_spec

# -- Project information -----------------------------------------------------

project = 'Wiki'

# -- General configuration ---------------------------------------------------

extensions = [
  'myst_parser',
  'sphinxext.opengraph',
]

# Extension only used for deployments
if find_spec('sphinxext') is None:
    extensions.remove('sphinxext.opengraph')

exclude_patterns = ['_build']
source_suffix = { '.md': 'markdown' }
templates_path = ['_templates']

# -- Options for MyST --------------------------------------------------------

myst_enable_extensions = [
    'colon_fence',
    'deflist',
]

# -- Options for Open Graph --------------------------------------------------

ogp_site_url = 'https://wiki.danielcapella.com'
ogp_type = 'article'

# -- Options for HTML output -------------------------------------------------

html_theme = 'furo'
html_theme_options = {
    'source_repository': 'https://gitlab.com/polyzen/wiki',
    'source_branch': 'master',
    'source_directory': '/',
}
html_title = project
html_favicon = '_static/favicon.svg'
html_static_path = ['_static']
html_use_index = False
html_copy_source = False

# -- Options for link checker ------------------------------------------------

linkcheck_ignore = ['https://tt-rss.org']