conf.py 1.98 KB
Newer Older
Jiahang Chen's avatar
Jiahang Chen committed
1
2
3
4
5
6
7
8
9
10
11
12
# 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.
#
Jiahang Chen's avatar
Jiahang Chen committed
13
14
15
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
Jiahang Chen's avatar
Jiahang Chen committed
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

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}


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

project = 'Python Reference Implementation of fml40'
copyright = '2020, KWH40'
author = 'KWH40'


# -- 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 = ['sphinx.ext.autodoc']

# Add any paths that contain templates here, relative to this directory.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'recommonmark']


# 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.
#
Jiahang Chen's avatar
Jiahang Chen committed
53
html_theme = 'nature'
Jiahang Chen's avatar
Jiahang Chen committed
54
55
56
57

# 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".
GromeTT's avatar
GromeTT committed
58
html_static_path = ['_static']
Jiahang Chen's avatar
Jiahang Chen committed
59
html_logo = "_static/logo.png"