add SVP64 CR EXTRA field-extension, from 3-bit to 7-bit (plus isvec)
[soc.git] / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # Configuration file for the Sphinx documentation builder.
4 #
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
8
9 # -- Path setup --------------------------------------------------------------
10
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.
14 #
15 import os
16 import sys
17 sys.path.insert(0, os.path.abspath('.'))
18 import recommonmark
19 from recommonmark.transform import AutoStructify
20
21 # -- Project information -----------------------------------------------------
22
23 project = 'Libre-SOC'
24 copyright = '2020 lkcl@libre-soc.org and Libre-SOC Team'
25 author = 'lkcl@libre-soc.org'
26
27 # The short X.Y version
28 version = ''
29 # The full version, including alpha/beta/rc tags
30 release = ''
31
32
33 # -- General configuration ---------------------------------------------------
34
35 # If your documentation needs a minimal Sphinx version, state it here.
36 #
37 # needs_sphinx = '1.0'
38
39 # Add any Sphinx extension module names here, as strings. They can be
40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41 # ones.
42 extensions = [
43 'sphinx.ext.autodoc',
44 'sphinx.ext.intersphinx',
45 'sphinx.ext.todo',
46 'sphinx.ext.napoleon',
47 'sphinx.ext.coverage',
48 'recommonmark',
49 #'symbolator_sphinx',
50 'sphinxcontrib_verilog_diagrams',
51 'sphinx_rtd_theme',
52 #'sphinx_tabs.tabs',
53 ]
54
55 # Add any paths that contain templates here, relative to this directory.
56 templates_path = ['html/_templates']
57
58 # The suffix(es) of source filenames.
59 # You can specify multiple suffix as a list of string:
60 #
61 source_suffix = {
62 '.rst': 'restructuredtext',
63 '.txt': 'markdown',
64 '.md': 'markdown',
65 }
66 source_suffix = ['.rst', '.md']
67
68 # The master toctree document.
69 master_doc = 'index'
70
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
73 #
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.
76 language = None
77
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']
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86
87 # -- Options for HTML output -------------------------------------------------
88
89 # The theme to use for HTML and HTML Help pages. See the documentation for
90 # a list of builtin themes.
91 #
92 html_theme = 'sphinx_rtd_theme'
93
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
96 # documentation.
97 #
98 # html_theme_options = {}
99
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']
104
105 # Custom sidebar templates, must be a dictionary that maps document names
106 # to template names.
107 #
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']``.
112 #
113 # html_sidebars = {}
114
115
116 # -- Options for HTMLHelp output ---------------------------------------------
117
118 # Output file base name for HTML help builder.
119 htmlhelp_basename = 'Libre-SOCdoc'
120
121
122 # -- Options for LaTeX output ------------------------------------------------
123
124 latex_elements = {
125 # The paper size ('letterpaper' or 'a4paper').
126 #
127 # 'papersize': 'letterpaper',
128
129 # The font size ('10pt', '11pt' or '12pt').
130 #
131 # 'pointsize': '10pt',
132
133 # Additional stuff for the LaTeX preamble.
134 #
135 # 'preamble': '',
136
137 # Latex figure (float) alignment
138 #
139 # 'figure_align': 'htbp',
140 }
141
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]).
145 latex_documents = [
146 (master_doc, 'Libre-SOC.tex', 'Libre-SOC Documentation',
147 'lkcl@libre-soc.org', 'manual'),
148 ]
149
150
151 # -- Options for manual page output ------------------------------------------
152
153 # One entry per manual page. List of tuples
154 # (source start file, name, description, authors, manual section).
155 man_pages = [
156 (master_doc, 'libre-soc', 'Libre-SOC Documentation',
157 [author], 1)
158 ]
159
160
161 # -- Options for Texinfo output ----------------------------------------------
162
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.',
169 'Miscellaneous'),
170 ]
171
172
173 # -- Extension configuration -------------------------------------------------
174
175 # -- Options for intersphinx extension ---------------------------------------
176
177 # Example configuration for intersphinx: refer to the Python standard library.
178 intersphinx_mapping = {"python": ('https://docs.python.org/3', None),
179 "nmigen": ('https://nmigen.info/nmigen', 'latest')
180 }
181
182 # -- Options for todo extension ----------------------------------------------
183
184 # If true, `todo` and `todoList` produce output, else they produce nothing.
185 todo_include_todos = True
186
187 # app setup hook
188 def setup(app):
189 app.add_config_value('recommonmark_config', {
190 #'url_resolver': lambda url: github_doc_root + url,
191 'auto_toc_tree_section': 'Contents',
192 'enable_math': False,
193 'enable_inline_math': False,
194 'enable_eval_rst': True,
195 'enable_auto_doc_ref': True,
196 }, True)
197 app.add_transform(AutoStructify)