1 # -*- coding: utf-8 -*-
3 # Configuration file for the Sphinx documentation builder.
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/master/config
9 # -- Path setup --------------------------------------------------------------
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
17 sys
.path
.insert(0, os
.path
.abspath('.'))
19 from recommonmark
.transform
import AutoStructify
21 # -- Project information -----------------------------------------------------
24 copyright
= '2020 lkcl@libre-soc.org and Libre-SOC Team'
25 author
= 'lkcl@libre-soc.org'
27 # The short X.Y version
29 # The full version, including alpha/beta/rc tags
33 # -- General configuration ---------------------------------------------------
35 # If your documentation needs a minimal Sphinx version, state it here.
37 # needs_sphinx = '1.0'
39 # Add any Sphinx extension module names here, as strings. They can be
40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44 'sphinx.ext.intersphinx',
46 'sphinx.ext.napoleon',
47 'sphinx.ext.coverage',
50 'sphinxcontrib_verilog_diagrams',
55 # Add any paths that contain templates here, relative to this directory.
56 templates_path
= ['html/_templates']
58 # The suffix(es) of source filenames.
59 # You can specify multiple suffix as a list of string:
62 '.rst': 'restructuredtext',
66 source_suffix
= ['.rst', '.md']
68 # The master toctree document.
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
74 # This is also used if you do content translation via gettext catalogs.
75 # Usually you set "language" from the command line for these cases.
78 # List of patterns, relative to source directory, that match files and
79 # directories to ignore when looking for source files.
80 # This pattern also affects html_static_path and html_extra_path .
81 exclude_patterns
= ['build', 'gen', 'proof*', 'libreriscv']
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style
= 'sphinx'
87 # -- Options for HTML output -------------------------------------------------
89 # The theme to use for HTML and HTML Help pages. See the documentation for
90 # a list of builtin themes.
92 html_theme
= 'sphinx_rtd_theme'
94 # Theme options are theme-specific and customize the look and feel of a theme
95 # further. For a list of options available for each theme, see the
98 # html_theme_options = {}
100 # Add any paths that contain custom static files (such as style sheets) here,
101 # relative to this directory. They are copied after the builtin static files,
102 # so a file named "default.css" will overwrite the builtin "default.css".
103 html_static_path
= ['html/_static']
105 # Custom sidebar templates, must be a dictionary that maps document names
108 # The default sidebars (for documents that don't match any pattern) are
109 # defined by theme itself. Builtin themes are using these templates by
110 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
111 # 'searchbox.html']``.
116 # -- Options for HTMLHelp output ---------------------------------------------
118 # Output file base name for HTML help builder.
119 htmlhelp_basename
= 'Libre-SOCdoc'
122 # -- Options for LaTeX output ------------------------------------------------
125 # The paper size ('letterpaper' or 'a4paper').
127 # 'papersize': 'letterpaper',
129 # The font size ('10pt', '11pt' or '12pt').
131 # 'pointsize': '10pt',
133 # Additional stuff for the LaTeX preamble.
137 # Latex figure (float) alignment
139 # 'figure_align': 'htbp',
142 # Grouping the document tree into LaTeX files. List of tuples
143 # (source start file, target name, title,
144 # author, documentclass [howto, manual, or own class]).
146 (master_doc
, 'Libre-SOC.tex', 'Libre-SOC Documentation',
147 'lkcl@libre-soc.org', 'manual'),
151 # -- Options for manual page output ------------------------------------------
153 # One entry per manual page. List of tuples
154 # (source start file, name, description, authors, manual section).
156 (master_doc
, 'libre-soc', 'Libre-SOC Documentation',
161 # -- Options for Texinfo output ----------------------------------------------
163 # Grouping the document tree into Texinfo files. List of tuples
164 # (source start file, target name, title, author,
165 # dir menu entry, description, category)
166 texinfo_documents
= [
167 (master_doc
, 'Libre-SOC', 'Libre-SOC Documentation',
168 author
, 'Libre-SOC', 'One line description of project.',
173 # -- Extension configuration -------------------------------------------------
175 # -- Options for intersphinx extension ---------------------------------------
177 lsocbase
= 'https://docs.libre-soc.org/'
178 # Example configuration for intersphinx: refer to the Python standard library.
179 intersphinx_mapping
= {"python": ('https://docs.python.org/3', None),
180 "nmigen": ('https://nmigen.info/nmigen', 'latest'),
181 "openpower": (lsocbase
+'openpower-isa', None),
182 #"nmutil": (lsocbase+'nmutil', None),
183 #"ieee754fpu": (lsocbase+'ieee754fpu', None),
186 # -- Options for todo extension ----------------------------------------------
188 # If true, `todo` and `todoList` produce output, else they produce nothing.
189 todo_include_todos
= True
193 app
.add_config_value('recommonmark_config', {
194 #'url_resolver': lambda url: github_doc_root + url,
195 'auto_toc_tree_section': 'Contents',
196 'enable_math': False,
197 'enable_inline_math': False,
198 'enable_eval_rst': True,
199 'enable_auto_doc_ref': True,
201 app
.add_transform(AutoStructify
)