conf.py 2.68 KB
Newer Older
Xuqian Yan's avatar
Xuqian Yan committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

17
18
19
20
# To enable AutoStructify: https://github.com/readthedocs/recommonmark#autostructify
import recommonmark
from recommonmark.transform import AutoStructify

Xuqian Yan's avatar
Xuqian Yan committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

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

project = 'Nexus-e'
copyright = '2020, Xuqian Yan'
author = 'Xuqian Yan'

# The full version, including alpha/beta/rc tags
release = '0.0.1'


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

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
38
39
'recommonmark',
'sphinxemoji.sphinxemoji',
Xuqian Yan's avatar
Xuqian Yan committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
61
html_static_path = ['_static']
62
63
64
65
# custom stylesheet is _static/css/custom.css
html_css_files = [
'css/custom.css'
]
66
67
68

# Based on https://github.com/readthedocs/readthedocs.org/issues/2569
master_doc = 'index'
69
70
71
72
73
74
75
76

# https://www.sphinx-doc.org/en/master/usage/markdown.html
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

77
78
79
80
81
82
83
84
# To enable AutoStructify: https://github.com/readthedocs/recommonmark#autostructify
def setup(app):
    app.add_config_value('recommonmark_config', {
            'url_resolver': lambda url: github_doc_root + url,
            'auto_toc_tree_section': 'Contents',
            }, True)
    app.add_transform(AutoStructify)