conf.py 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. from __future__ import annotations
  7. import os
  8. import sys
  9. # If extensions (or modules to document with autodoc) are in another directory,
  10. # add these directories to sys.path here. If the directory is relative to the
  11. # documentation root, use os.path.abspath to make it absolute, like shown here.
  12. sys.path.insert(0, os.path.abspath("../.."))
  13. from mypy.version import __version__ as mypy_version
  14. # -- Project information -----------------------------------------------------
  15. project = "mypyc"
  16. copyright = "2020-2022, mypyc team"
  17. author = "mypyc team"
  18. # The version info for the project you're documenting, acts as replacement for
  19. # |version| and |release|, also used in various other places throughout the
  20. # built documents.
  21. #
  22. # The short X.Y version.
  23. version = mypy_version.split("-")[0]
  24. # The full version, including alpha/beta/rc tags.
  25. release = mypy_version
  26. # -- General configuration ---------------------------------------------------
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  29. # ones.
  30. extensions = [] # type: ignore[var-annotated]
  31. # Add any paths that contain templates here, relative to this directory.
  32. templates_path = ["_templates"]
  33. # List of patterns, relative to source directory, that match files and
  34. # directories to ignore when looking for source files.
  35. # This pattern also affects html_static_path and html_extra_path.
  36. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
  37. # -- Options for HTML output -------------------------------------------------
  38. # The theme to use for HTML and HTML Help pages. See the documentation for
  39. # a list of builtin themes.
  40. html_theme = "furo"
  41. # Add any paths that contain custom static files (such as style sheets) here,
  42. # relative to this directory. They are copied after the builtin static files,
  43. # so a file named "default.css" will overwrite the builtin "default.css".
  44. html_static_path = ["_static"]