|
1
|
|
|
# -*- coding: utf-8 -*- |
|
2
|
|
|
"""Configuration for apexpy documentation.""" |
|
3
|
|
|
import os |
|
4
|
|
|
from pyproject_parser import PyProject |
|
5
|
|
|
|
|
6
|
|
|
extensions = ['sphinx.ext.autodoc', |
|
7
|
|
|
'sphinx.ext.autosummary', |
|
8
|
|
|
'sphinx.ext.coverage', |
|
9
|
|
|
'sphinx.ext.viewcode', |
|
10
|
|
|
'sphinx.ext.githubpages', |
|
11
|
|
|
'sphinx.ext.napoleon', |
|
12
|
|
|
'sphinx.ext.extlinks', |
|
13
|
|
|
'autoapi.extension'] |
|
14
|
|
|
|
|
15
|
|
|
# General information about the project. |
|
16
|
|
|
info = PyProject.load("../pyproject.toml") |
|
17
|
|
|
|
|
18
|
|
|
# Define common elements |
|
19
|
|
|
source_suffix = '.rst' |
|
20
|
|
|
master_doc = 'index' |
|
21
|
|
|
project = 'ApexPy' |
|
22
|
|
|
year = '2024' |
|
23
|
|
|
author = 'the apexpy team' |
|
24
|
|
|
copyright = ', '.join([year, author]) |
|
25
|
|
|
version = release = info.project['version'].base_version |
|
26
|
|
|
|
|
27
|
|
|
# Configure autoapi |
|
28
|
|
|
autoapi_type = 'python' |
|
29
|
|
|
autoapi_dirs = ['../apexpy'] |
|
30
|
|
|
autoapi_keep_files = True |
|
31
|
|
|
autoapi_root = 'autoapi/generated' |
|
32
|
|
|
|
|
33
|
|
|
# The name of an image file (relative to this directory) to place at the top |
|
34
|
|
|
# of the sidebar. |
|
35
|
|
|
html_logo = os.path.join(os.path.abspath('.'), 'apexpy.png') |
|
36
|
|
|
|
|
37
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
38
|
|
|
# a list of builtin themes. |
|
39
|
|
|
html_theme = 'sphinx_rtd_theme' |
|
40
|
|
|
html_theme_path = ["_themes", ] |
|
41
|
|
|
|
|
42
|
|
|
pygments_style = 'trac' |
|
43
|
|
|
templates_path = ['.'] |
|
44
|
|
|
html_use_smartypants = True |
|
45
|
|
|
html_last_updated_fmt = '%b %d, %Y' |
|
46
|
|
|
html_split_index = True |
|
47
|
|
|
html_sidebars = {'**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html']} |
|
48
|
|
|
html_short_title = '-'.join([project, version]) |
|
49
|
|
|
autodoc_member_order = 'bysource' |
|
50
|
|
|
autodoc_mock_imports = ['apexpy'] |
|
51
|
|
|
napoleon_use_ivar = True |
|
52
|
|
|
napoleon_use_rtype = False |
|
53
|
|
|
napoleon_use_param = False |
|
54
|
|
|
|
|
55
|
|
|
extlinks = {'doi': ('http://dx.doi.org/%s', 'doi:%s')} |
|
56
|
|
|
|
aburrell /
apexpy
