diff options
| author | perigoso <[email protected]> | 2021-07-26 19:18:12 +0100 |
|---|---|---|
| committer | perigoso <[email protected]> | 2021-07-30 12:46:15 +0100 |
| commit | bf99adc3c9f0306e263677e17bfaf0dee356f450 (patch) | |
| tree | 060df1e8d60a1b71bf4d6003ce424b220ee51f67 /docs/conf.py | |
| parent | c552677a5261c3664a0cebfe44192c340c62b671 (diff) | |
docs: setup sphinx docs
Signed-off-by: perigoso <[email protected]>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..c7a17478f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,42 @@ +# 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 -------------------------------------------------------------- + + +# -- Project information ----------------------------------------------------- + +project = 'TinyUSB' +copyright = '2021, Ha Thach' +author = 'Ha Thach' + + +# -- General configuration --------------------------------------------------- + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx_autodoc_typehints', + 'sphinxemoji.sphinxemoji', +] + +templates_path = ['_templates'] + +exclude_patterns = ['_build'] + + +# -- Options for HTML output ------------------------------------------------- + +html_theme = 'furo' +html_title = 'TinyUSB' +html_logo = 'assets/logo.svg' +html_favicon = 'assets/logo.svg' +html_theme_options = { + 'sidebar_hide_name': True, +} + +todo_include_todos = True |
