Skip to content
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

TYP: Improve the doc style for type hints #2813

Merged
merged 9 commits into from
Dec 7, 2023
Merged

TYP: Improve the doc style for type hints #2813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cc6c461
Add partial type hints support to load_earth_relief
seisman Nov 2, 2023
5c5864c
Set autodoc_typehints to description
seisman Nov 15, 2023
9ceacb9
Use the sphinx-autodoc-typehints extension
seisman Nov 15, 2023
c7be7b1
Remove autodoc_typehints and set typehints_defaults to 'comma'
seisman Nov 15, 2023
66c4e69
Merge branch 'main' into typehints/doc-style
seisman Dec 4, 2023
7a3189a
Update environment.yml
seisman Dec 4, 2023
15b2c07
Merge branch 'main' into typehints/doc-style
seisman Dec 6, 2023
f3c1b19
Revert "Add partial type hints support to load_earth_relief"
seisman Dec 6, 2023
4bc5912
Merge branch 'main' into typehints/doc-style
yvonnefroehlich Dec 7, 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 .github/workflows/ci_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ jobs:
myst-parser
panel
sphinx
sphinx-autodoc-typehints
sphinx-copybutton
sphinx-design
sphinx-gallery
Expand Down
1 change: 1 addition & 0 deletions ci/requirements/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ dependencies:
- myst-parser
- panel
- sphinx
- sphinx-autodoc-typehints
- sphinx-copybutton
- sphinx-design
- sphinx-gallery
Expand Down
4 changes: 4 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
"sphinx_copybutton",
"sphinx_design",
"sphinx_gallery.gen_gallery",
Expand All @@ -41,6 +42,9 @@
napoleon_use_rtype = False
napoleon_use_ivar = True

# sphinx_auto_typehints
typehints_defaults = "comma"

# configure links to GMT docs
extlinks = {
"gmt-docs": ("https://docs.generic-mapping-tools.org/6.4/%s", None),
Expand Down
1 change: 1 addition & 0 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ dependencies:
- myst-parser
- panel
- sphinx
- sphinx-autodoc-typehints
- sphinx-copybutton
- sphinx-design
- sphinx-gallery
Expand Down