conf.py 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. # Configuration file for the Sphinx documentation builder.
  2. #
  3. # For the full list of built-in configuration values, see the documentation:
  4. # https://www.sphinx-doc.org/en/master/usage/configuration.html
  5. import os
  6. import sys
  7. sys.path.append(os.path.abspath('../../'))
  8. # -- Project information -----------------------------------------------------
  9. # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
  10. project = 'swiftt'
  11. copyright = '2022, Romain Serra'
  12. author = 'Romain Serra'
  13. release = '1.0'
  14. # -- General configuration ---------------------------------------------------
  15. # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  16. extensions = ['sphinx.ext.napoleon', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary']
  17. autosummary_generate = True # Turn on sphinx.ext.autosummary
  18. napoleon_include_special_with_doc = True
  19. napoleon_custom_sections = [('Returns', 'params_style')]
  20. templates_path = ['_templates']
  21. exclude_patterns = ['_build', '_templates']
  22. # -- Options for HTML output -------------------------------------------------
  23. # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  24. html_theme = 'alabaster'
  25. html_static_path = ['_static']