aburrell /
aacgmv2
| Total Complexity | 0 |
| Total Lines | 42 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
| 1 | """Configuration file for documetation.""" |
||
| 2 | import os |
||
| 3 | from pyproject_parser import PyProject |
||
| 4 | |||
| 5 | extensions = ['sphinx.ext.autodoc', |
||
| 6 | 'sphinx.ext.autosummary', |
||
| 7 | 'sphinx.ext.todo', |
||
| 8 | 'sphinx.ext.coverage', |
||
| 9 | 'sphinx.ext.ifconfig', |
||
| 10 | 'sphinx.ext.viewcode', |
||
| 11 | 'sphinx.ext.napoleon', |
||
| 12 | 'numpydoc'] |
||
| 13 | |||
| 14 | # General information about the project. |
||
| 15 | info = PyProject.load("../pyproject.toml") |
||
| 16 | |||
| 17 | # Set the basic variables |
||
| 18 | source_suffix = '.rst' |
||
| 19 | master_doc = 'index' |
||
| 20 | project = 'AACGM-v2 Python library' |
||
| 21 | year = '2024' |
||
| 22 | author = 'Angeline G. Burrell, et al.' |
||
| 23 | copyright = '{0}, {1}'.format(year, author) |
||
| 24 | version = release = info.project['version'].base_version |
||
| 25 | |||
| 26 | # `on_rtd` is whether we are on readthedocs.org |
||
| 27 | on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
||
| 28 | |||
| 29 | # Only import and set the theme if we're building docs locally |
||
| 30 | if not on_rtd: |
||
| 31 | import sphinx_rtd_theme |
||
| 32 | html_theme = 'sphinx_rtd_theme' |
||
| 33 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
||
| 34 | |||
| 35 | pygments_style = 'trac' |
||
| 36 | templates_path = ['.'] |
||
| 37 | html_use_smartypants = True |
||
| 38 | html_last_updated_fmt = '%b %d, %Y' |
||
| 39 | html_split_index = True |
||
| 40 | html_sidebars = {'**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html']} |
||
| 41 | html_short_title = '%s-%s' % (project, version) |
||
| 42 |
