1234567891011121314151617181920212223242526272829303132333435 |
- # 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
- import os
- import sys
- sys.path.append(os.path.abspath('../../'))
- # -- Project information -----------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
- project = 'swiftt'
- copyright = '2022, Romain Serra'
- author = 'Romain Serra'
- release = '1.0'
- # -- General configuration ---------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
- extensions = ['sphinx.ext.napoleon', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary']
- autosummary_generate = True # Turn on sphinx.ext.autosummary
- napoleon_include_special_with_doc = True
- napoleon_custom_sections = [('Returns', 'params_style')]
- templates_path = ['_templates']
- exclude_patterns = ['_build', '_templates']
- # -- Options for HTML output -------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
- html_theme = 'alabaster'
- html_static_path = ['_static']
|