| Austin Schuh | 41baf20 | 2022-01-01 14:33:40 -0800 | [diff] [blame^] | 1 | # Configuration file for the Sphinx documentation builder. |
| 2 | # |
| 3 | # This file only contains a selection of the most common options. For a full |
| 4 | # list see the documentation: |
| 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 6 | |
| 7 | # -- Path setup -------------------------------------------------------------- |
| 8 | |
| 9 | |
| 10 | # -- Project information ----------------------------------------------------- |
| 11 | |
| 12 | project = 'TinyUSB' |
| 13 | copyright = '2021, Ha Thach' |
| 14 | author = 'Ha Thach' |
| 15 | |
| 16 | |
| 17 | # -- General configuration --------------------------------------------------- |
| 18 | |
| 19 | extensions = [ |
| 20 | 'sphinx.ext.autodoc', |
| 21 | 'sphinx.ext.intersphinx', |
| 22 | 'sphinx.ext.todo', |
| 23 | 'sphinx_autodoc_typehints', |
| 24 | ] |
| 25 | |
| 26 | templates_path = ['_templates'] |
| 27 | |
| 28 | exclude_patterns = ['_build'] |
| 29 | |
| 30 | |
| 31 | # -- Options for HTML output ------------------------------------------------- |
| 32 | |
| 33 | html_theme = 'furo' |
| 34 | html_title = 'TinyUSB' |
| 35 | html_logo = 'assets/logo.svg' |
| 36 | html_favicon = 'assets/logo.svg' |
| 37 | html_theme_options = { |
| 38 | 'sidebar_hide_name': True, |
| 39 | } |
| 40 | |
| 41 | todo_include_todos = True |