conf.py 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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. # -- Project information -----------------------------------------------------
  6. # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
  7. project = "Synapse development"
  8. copyright = "2023, The Matrix.org Foundation C.I.C."
  9. author = "The Synapse Maintainers and Community"
  10. # -- General configuration ---------------------------------------------------
  11. # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  12. extensions = [
  13. "autodoc2",
  14. "myst_parser",
  15. ]
  16. templates_path = ["_templates"]
  17. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
  18. # -- Options for Autodoc2 ----------------------------------------------------
  19. autodoc2_docstring_parser_regexes = [
  20. # this will render all docstrings as 'MyST' Markdown
  21. (r".*", "myst"),
  22. ]
  23. autodoc2_packages = [
  24. {
  25. "path": "../synapse",
  26. # Don't render documentation for everything as a matter of course
  27. "auto_mode": False,
  28. },
  29. ]
  30. # -- Options for MyST (Markdown) ---------------------------------------------
  31. # myst_heading_anchors = 2
  32. # -- Options for HTML output -------------------------------------------------
  33. # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  34. html_theme = "furo"
  35. html_static_path = ["_static"]