diff options
| author | Miodrag Milanovic <mmicko@gmail.com> | 2024-11-29 09:04:06 +0100 |
|---|---|---|
| committer | Miodrag Milanovic <mmicko@gmail.com> | 2024-11-29 09:04:06 +0100 |
| commit | 42be8d5bf0c2c6f3422b14cc4d264da7781da43b (patch) | |
| tree | a9692b6c12f964859df2143704750c9877bd33b6 /docs/source/conf.py | |
| parent | 738af822905fdcf0466e9dd784b9ae4b0b34987f (diff) | |
Start converting documentation to Sphinx
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..6036d28 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,33 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Project Icestorm' +copyright = '2024, YosysHQ' +author = 'YosysHQ' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx_rtd_theme'] + +templates_path = ['_templates'] +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_theme_options = { + "collapse_navigation": True, + "sticky_navigation": True, + "includehidden": True, + "navigation_depth": 4, + "titles_only": False +} +html_static_path = ['_static'] |
