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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
#!/usr/bin/env python3
#
# poliastro documentation build configuration file.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
import os
from importlib.metadata import version
import sphinx_rtd_theme
extensions = [
"autoapi.extension",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"sphinx.ext.intersphinx",
"nbsphinx",
"sphinx_gallery.load_style",
"IPython.sphinxext.ipython_console_highlighting",
"sphinx.ext.mathjax", # Maths visualization
"sphinx.ext.graphviz", # Dependency diagrams
"sphinx_copybutton",
"notfound.extension",
"hoverxref.extension",
"myst_parser",
"sphinx_github_role",
]
# GitHub role config
github_default_org_project = ("poliastro", "poliastro")
# MathJax config
# See https://github.com/spatialaudio/nbsphinx/issues/572#issuecomment-853389268
mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
mathjax2_config = {
"tex2jax": {
"inlineMath": [["$", "$"], ["\\(", "\\)"]],
"processEscapes": True,
"ignoreClass": "document",
"processClass": "math|output_area",
}
}
myst_update_mathjax = False
myst_enable_extensions = [
"substitution",
]
myst_substitutions = {
"Ephem": "{py:class}`~poliastro.ephem.Ephem`",
"Orbit": "{py:class}`~poliastro.twobody.orbit.scalar.Orbit`",
}
# Hoverxref Extension
hoverxref_auto_ref = True
hoverxref_mathjax = True
hoverxref_intersphinx = [
"astropy",
"numpy",
"scipy",
"matplotlib",
]
hoverxref_domains = ["py"]
hoverxref_role_types = {
"hoverxref": "modal",
"ref": "modal", # for hoverxref_auto_ref config
"confval": "tooltip", # for custom object
"mod": "tooltip", # for Python Sphinx Domain
"class": "tooltip", # for Python Sphinx Domain
"meth": "tooltip",
"obj": "tooltip",
}
# Other
autodoc_member_order = "bysource"
templates_path = ["_templates"]
# source_suffix = ['.rst' , '.md']
project = "poliastro"
copyright = "2013, Juan Luis Cano RodrÃguez and the poliastro development team"
project_ver = version(project)
version = ".".join(project_ver.split(".")[:2])
release = project_ver
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# Intersphinx configuration
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"astropy": ("https://docs.astropy.org/en/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy-1.8.0/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
}
# Warning suppresses
suppress_warnings = ["image.nonlocal_uri"]
if os.environ.get("POLIASTRO_SKIP_NOTEBOOKS") == "True":
nbsphinx_execute = "never"
suppress_warnings.append("nbsphinx.thumbnail")
else:
nbsphinx_execute = "always"
# -- Options for HTML output
html_theme = "sphinx_rtd_theme"
html_context = {
"sidebar_external_links_caption": "Links",
"sidebar_external_links": [
(
'<i class="fa fa-rss fa-fw"></i> Blog',
"https://www.poliastro.space",
),
(
'<i class="fa fa-github fa-fw"></i> Source code',
"https://github.com/poliastro/poliastro",
),
(
'<i class="fa fa-bug fa-fw"></i> Issue tracker',
"https://github.com/poliastro/poliastro/issues",
),
(
'<i class="fa fa-envelope fa-fw"></i> Mailing list',
"https://groups.io/g/poliastro-dev",
),
(
'<i class="fa fa-comments fa-fw"></i> Chat',
"http://chat.poliastro.space",
),
(
'<i class="fa fa-file-text fa-fw"></i> Citation',
"https://doi.org/10.5281/zenodo.593610",
),
],
}
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_style = os.path.join("css", "custom.css")
html_favicon = os.path.join("_static", "favicon.ico")
html_static_path = ["_static"]
html_js_files = ["language_data.js"]
# Thumbnail selection for nbsphinx gallery
nbsphinx_thumbnails = {
"examples/Going to Mars with Python using poliastro": "_static/thumbnails/going_to_mars_thumbnail.png",
"examples/Plotting in 3D": "_static/thumbnails/3d_plotting_thumbnail.png",
"examples/Propagation using Cowells formulation": "_static/thumbnails/cowell_thumbnail.png",
"examples/CZML Tutorial": "_static/thumbnails/cesium_thumbnail.png",
"examples/Generating orbit groundtracks": "_static/thumbnails/groundtrack.png",
"examples/Detecting Events": "_static/thumbnails/eclipse.png",
"examples/Loading OMM and TLE satellite data": "_static/thumbnails/omm_debris.png",
"examples/Multirevolutions solution in Lamberts problem": "_static/thumbnails/lambert_paths.png",
}
nbsphinx_custom_formats = {
".mystnb": ["jupytext.reads", {"fmt": "mystnb"}],
}
# sphinx-autoapi configuration
autoapi_type = "python"
autoapi_dirs = ["../../src/"]
autoapi_options = [
"members",
"undoc-members",
"show-inheritance",
"show-module-summary",
"special-members",
"inherited-members",
]
autoapi_add_toctree_entry = False
autoapi_ignore = [
"*_compat*", # To avoid WARNING: more than one target found for cross-reference '__class__'
]
exclude_patterns.extend(["autoapi/index.rst", "autoapi/poliastro/index.rst"])
# Ignore sphinx-autoapi warnings on reimported objects
# See https://github.com/readthedocs/sphinx-autoapi/issues/285
suppress_warnings.append("autoapi.python_import_resolution")
|
