Skip to content

Add sphinx-codeautolink extension to docs build #7011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Add sphinx-codeautolink extension to docs build #7011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e70fac5
add sphinx-codeautolink extension to docs build
TomNicholas Sep 8, 2022
6614302
Merge branch 'main' into sphinx-codeautolink
dcherian Oct 3, 2022
c3bfa0d
Merge branch 'main' into sphinx-codeautolink
dcherian Nov 4, 2022
6da13ce
Merge branch 'main' into sphinx-codeautolink
dcherian Nov 5, 2022
379370a
concat notebook cells by default
dcherian Jan 15, 2023
cf334f1
Merge branch 'main' into sphinx-codeautolink
dcherian Jan 15, 2023
6bf4656
Merge branch 'main' into sphinx-codeautolink
dcherian Jan 26, 2023
db49fa3
Avoid starting blocks with comments
dcherian Jan 16, 2023
85e2c15
Revert "Avoid starting blocks with comments"
dcherian Feb 6, 2023
ef14b31
Add global preface
dcherian Feb 6, 2023
041a57f
move to conda-forge
dcherian Feb 6, 2023
8f67808
Add inventory map.
dcherian Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ci/requirements/doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ dependencies:
- sparse
- sphinx-autosummary-accessors
- sphinx-book-theme >= 0.0.38
- sphinx-codeautolink
- sphinx-copybutton
- sphinx-design
- sphinx!=4.4.0
Expand Down
14 changes: 14 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
"IPython.sphinxext.ipython_console_highlighting",
"nbsphinx",
"sphinx_autosummary_accessors",
"sphinx_codeautolink",
"sphinx.ext.linkcode",
"sphinxext.opengraph",
"sphinx_copybutton",
Expand Down Expand Up @@ -121,6 +122,19 @@
autosummary_generate = True
autodoc_typehints = "none"

# codeautolink
codeautolink_concat_default = True
codeautolink_global_preface = """
import dask
import numpy as np
import pandas as pd
import xarray as xr
"""
codeautolink_inventory_map = {
"xarray.core.dataarray.DataArray": "xarray.DataArray",
"xarray.core.dataset.Dataset": "xarray.Dataset",
}

# Napoleon configurations

napoleon_google_docstring = False
Expand Down