Skip to content

Commit 1b90430

Browse files
committed
Added support for sphinx-codeautolink in the documentation.
1 parent 0be9bc5 commit 1b90430

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/conf.py

+7
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
'sphinx.ext.viewcode',
3838
'sphinxcontrib.bibtex',
3939
'jupyter_sphinx',
40+
'sphinx_codeautolink',
4041
]
4142
autosummary_generate = True # Turn on sphinx.ext.autosummary
4243
autosummary_imported_members = True
@@ -98,9 +99,15 @@
9899
bibtex_default_style = 'plain'
99100
bibtex_reference_style = 'author_year'
100101

102+
codeautolink_custom_blocks = {"jupyter-execute": None}
103+
codeautolink_warn_on_missing_inventory = True
104+
codeautolink_warn_on_failed_resolve = True
105+
101106
intersphinx_mapping = {
102107
'python': ('https://docs.python.org/3', None),
103108
'numpy': ('https://numpy.org/doc/stable/', None),
109+
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
104110
'matplotlib': ('https://matplotlib.org/stable', None),
105111
'astropy': ('https://docs.astropy.org/en/stable/', None),
112+
'astroscrappy': ('https://astroscrappy.readthedocs.io/en/stable/', None)
106113
}

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ doc = [
3535
"sphinx-favicon",
3636
"scipy",
3737
"astroscrappy",
38+
"sphinx-codeautolink",
3839
]
3940

4041
[project.urls]

0 commit comments

Comments
 (0)