abseil-py

1
"""Sphinx config file for https://github.com/abseil/abseil-py."""
2

3
import os
4
import sys
5

6
# -- Project information
7
project = 'Abseil Python Common Libraries'
8
copyright = '2022, Abseil'  # pylint: disable=redefined-builtin
9
author = 'The Abseil Authors'
10

11
release = ''
12
version = ''
13

14
# -- General configuration
15

16
extensions = [
17
    'sphinx.ext.duration',
18
    'sphinx.ext.doctest',
19
    'sphinx.ext.autodoc',
20
    'sphinx.ext.autosummary',
21
    'sphinx.ext.intersphinx',
22
    'sphinx.ext.napoleon',
23
    'sphinx.ext.viewcode',
24
    'sphinx.ext.coverage',
25
    'sphinxcontrib.apidoc',  # convert .py sources to .rst docs.
26
    'm2r2',                  # for .md files
27
]
28

29
# sphinxcontrib.apidoc vars
30
apidoc_module_dir = '../../absl'
31
apidoc_output_dir = '.'
32
apidoc_toc_file = False
33
apidoc_excluded_paths = [
34
    '*/tests/*',
35
    'tests/*',
36
]
37
apidoc_separate_modules = True
38

39
intersphinx_mapping = {
40
    'python': ('https://docs.python.org/3/', None),
41
    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
42
}
43
intersphinx_disabled_domains = ['std']
44

45
source_suffix = {
46
    '.rst': 'restructuredtext',
47
    '.md': 'markdown',
48
}
49

50
templates_path = ['_templates']
51

52
# -- Options for HTML output
53

54
html_theme = 'sphinx_rtd_theme'
55

56
# -- Options for EPUB output
57
epub_show_urls = 'footnote'
58

59
sys.path.insert(0, os.path.abspath('../..'))       # access to README.md
60
sys.path.insert(0, os.path.abspath('../../absl'))  # access to python sources
61