GEOPHIRES/docs/conf.py at 3fdc98d413a94f097f3dada6a05d7e0ce69e107e · softwareengineerprogrammer/GEOPHIRES · GitHub

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
import sphinx_py3doc_enhanced_theme

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.coverage',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'sphinx.ext.ifconfig',
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
    'm2r2',
]
source_suffix = ['.rst', '.md']
master_doc = 'index'
project = 'geophires-x'
year = '2025'
author = 'NREL'
copyright = f'{year}, {author}'
version = release = '3.9.26'

pygments_style = 'trac'
templates_path = ['./templates']
extlinks = {
    'issue': ('https://github.com/NREL/GEOPHIRES-X/issues/%s', '#'),
    'pr': ('https://github.com/NREL/GEOPHIRES-X/pull/%s', 'PR #'),
}

# html_theme = 'alabaster' # alternative possible theme

html_theme = 'sphinx_py3doc_enhanced_theme'
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
html_theme_options = {
    'githuburl': 'https://github.com/NREL/GEOPHIRES-X/',
}

html_use_smartypants = True
html_last_updated_fmt = '%b %d, %Y'
html_split_index = False
html_sidebars = {
    '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
}
html_short_title = f'{project}-{version}'

napoleon_use_ivar = True
napoleon_use_rtype = False
napoleon_use_param = False