Kagome
Polkadot Runtime Engine in C++17
conf.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 #
3 from recommonmark.parser import CommonMarkParser
4 from recommonmark.transform import AutoStructify
5 # import sys
6 # sys.path.insert(0, os.path.abspath('.'))
7 
8 
9 # -- Project information -----------------------------------------------------
10 
11 project = 'Kagome'
12 copyright = '2020, Soramitsu Co., Ltd.'
13 author = 'Soramitsu Co., Ltd.'
14 
15 # The short X.Y version
16 version = ''
17 # The full version, including alpha/beta/rc tags
18 release = '0.0.1'
19 
20 # -- General configuration ---------------------------------------------------
21 
22 # If your documentation needs a minimal Sphinx version, state it here.
23 #
24 # needs_sphinx = '1.0'
25 
26 # Add any Sphinx extension module names here, as strings. They can be
27 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
28 # ones.
29 extensions = [
30  'sphinx.ext.todo',
31  'sphinx.ext.githubpages',
32  'sphinx_markdown_tables',
33  'recommonmark'
34 ]
35 
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38 
39 # The suffix(es) of source filenames.
40 # You can specify multiple suffix as a list of string:
41 #
42 # source_suffix = ['.rst', '.md']
43 source_suffix = {
44  '.rst': 'restructuredtext',
45  '.txt': 'markdown',
46  '.md': 'markdown',
47 }
48 
49 # The master toctree document.
50 master_doc = 'index'
51 
52 # The following enables AutoStructify to create decent TOCTrees out of MD lists
53 github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
54 def setup(app):
55  app.add_config_value('recommonmark_config', {
56  'url_resolver': lambda url: github_doc_root + url,
57  'auto_toc_tree_section': 'Contents',
58  }, True)
59  app.add_transform(AutoStructify)
60 
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
63 #
64 # This is also used if you do content translation via gettext catalogs.
65 # Usually you set "language" from the command line for these cases.
66 language = None
67 
68 # List of patterns, relative to source directory, that match files and
69 # directories to ignore when looking for source files.
70 # This pattern also affects html_static_path and html_extra_path .
71 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
72 
73 # The name of the Pygments (syntax highlighting) style to use.
74 pygments_style = 'sphinx'
75 
76 
77 # -- Options for HTML output -------------------------------------------------
78 
79 # The theme to use for HTML and HTML Help pages. See the documentation for
80 # a list of builtin themes.
81 #
82 
83 # Theme options are theme-specific and customize the look and feel of a theme
84 # further. For a list of options available for each theme, see the
85 # documentation.
86 #
87 # html_theme_options = {}
88 
89 # Add any paths that contain custom static files (such as style sheets) here,
90 # relative to this directory. They are copied after the builtin static files,
91 # so a file named "default.css" will overwrite the builtin "default.css".
92 html_static_path = ['_static']
93 
94 # Custom sidebar templates, must be a dictionary that maps document names
95 # to template names.
96 #
97 # The default sidebars (for documents that don't match any pattern) are
98 # defined by theme itself. Builtin themes are using these templates by
99 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
100 # 'searchbox.html']``.
101 #
102 # html_sidebars = {}
103 html_theme = 'sphinx_rtd_theme'
def setup(app)
Definition: conf.py:54