File: conf.py

package info (click to toggle)
extension-helpers 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 280 kB
  • sloc: python: 1,082; ansic: 69; makefile: 16
file content (55 lines) | stat: -rw-r--r-- 1,631 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
from pkg_resources import get_distribution

project = "extension-helpers"
copyright = "2019, The Astropy Developers"
author = "The Astropy Developers"

# We need to get the version number from the package
version = release = get_distribution("extension-helpers").version

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.napoleon",
    "sphinx_automodapi.automodapi",
]

intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "setuptools": ("https://setuptools.pypa.io/en/latest/", None),
}

# The suffix(es) of source filenames.
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = "alabaster"

html_theme_options = {
    "description": "A build time package to simplify C/Cython extensions.",
    "code_font_family": "'Fira Code', monospace",
    "github_user": "astropy",
    "github_repo": "extension-helpers",
    "sidebar_width": "300px",
}

# Enable nitpicky mode to pick reference issues
default_role = "obj"
nitpicky = True