From 2f84bfc28e882f315e3151f6f8ca87bc319e31b8 Mon Sep 17 00:00:00 2001 From: lgolston <30876419+lgolston@users.noreply.github.com> Date: Sun, 4 Jun 2023 14:45:50 -0500 Subject: [PATCH 1/4] improve autosummary docs --- .../_templates/autosummary/class_with_inherited.rst | 9 +++++++++ .../_templates/autosummary/class_without_inherited.rst | 2 ++ docs/source/reference/crs.rst | 6 ++++++ 3 files changed, 17 insertions(+) create mode 100644 docs/source/_templates/autosummary/class_with_inherited.rst diff --git a/docs/source/_templates/autosummary/class_with_inherited.rst b/docs/source/_templates/autosummary/class_with_inherited.rst new file mode 100644 index 000000000..bf8cf818d --- /dev/null +++ b/docs/source/_templates/autosummary/class_with_inherited.rst @@ -0,0 +1,9 @@ +{{ fullname }} +{{ underline }} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + :inherited-members: + :special-members: __init__ diff --git a/docs/source/_templates/autosummary/class_without_inherited.rst b/docs/source/_templates/autosummary/class_without_inherited.rst index a5c117823..f90c2b760 100644 --- a/docs/source/_templates/autosummary/class_without_inherited.rst +++ b/docs/source/_templates/autosummary/class_without_inherited.rst @@ -6,3 +6,5 @@ .. autoclass:: {{ objname }} :members: :no-inherited-members: + :show-inheritance: + :special-members: __init__ diff --git a/docs/source/reference/crs.rst b/docs/source/reference/crs.rst index 9ae2f0587..fcd820f7a 100644 --- a/docs/source/reference/crs.rst +++ b/docs/source/reference/crs.rst @@ -13,9 +13,15 @@ Base CRS's .. autosummary:: :toctree: generated/ + :template: autosummary/class_with_inherited.rst crs.CRS crs.Globe + +.. autosummary:: + :toctree: generated/ + :template: autosummary/class_without_inherited.rst + crs.Projection crs.Geodetic crs.Geocentric From b2dd6449da279d5ee59f412914b5da0a183c2ecc Mon Sep 17 00:00:00 2001 From: lgolston <30876419+lgolston@users.noreply.github.com> Date: Sun, 4 Jun 2023 22:09:19 -0500 Subject: [PATCH 2/4] remove trailing whitespace --- docs/source/reference/crs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/reference/crs.rst b/docs/source/reference/crs.rst index fcd820f7a..073e7244e 100644 --- a/docs/source/reference/crs.rst +++ b/docs/source/reference/crs.rst @@ -17,11 +17,11 @@ Base CRS's crs.CRS crs.Globe - + .. autosummary:: :toctree: generated/ :template: autosummary/class_without_inherited.rst - + crs.Projection crs.Geodetic crs.Geocentric From 75752bdc5b5e650261eff280f2e29f89ac0bfeea Mon Sep 17 00:00:00 2001 From: lgolston <30876419+lgolston@users.noreply.github.com> Date: Tue, 6 Jun 2023 07:52:49 -0500 Subject: [PATCH 3/4] improve docstring for __init__ --- docs/source/_templates/autosummary/class_with_inherited.rst | 1 - .../source/_templates/autosummary/class_without_inherited.rst | 1 - docs/source/conf.py | 4 ++++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/_templates/autosummary/class_with_inherited.rst b/docs/source/_templates/autosummary/class_with_inherited.rst index bf8cf818d..ed93a2966 100644 --- a/docs/source/_templates/autosummary/class_with_inherited.rst +++ b/docs/source/_templates/autosummary/class_with_inherited.rst @@ -6,4 +6,3 @@ .. autoclass:: {{ objname }} :members: :inherited-members: - :special-members: __init__ diff --git a/docs/source/_templates/autosummary/class_without_inherited.rst b/docs/source/_templates/autosummary/class_without_inherited.rst index f90c2b760..11e49c587 100644 --- a/docs/source/_templates/autosummary/class_without_inherited.rst +++ b/docs/source/_templates/autosummary/class_without_inherited.rst @@ -7,4 +7,3 @@ :members: :no-inherited-members: :show-inheritance: - :special-members: __init__ diff --git a/docs/source/conf.py b/docs/source/conf.py index 9002d56b6..a84be8c12 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -225,6 +225,10 @@ # Output file base name for HTML help builder. htmlhelp_basename = 'cartopydoc' +# Show both class-level docstring and __init__ docstring in class +# documentation +autoclass_content = 'both' + # -- Options for LaTeX output -------------------------------------------------- From 1a8f4ff995d688ac232f216aaa01ae68c9f34313 Mon Sep 17 00:00:00 2001 From: lgolston <30876419+lgolston@users.noreply.github.com> Date: Tue, 6 Jun 2023 22:50:30 -0500 Subject: [PATCH 4/4] use template without inheritance for crs --- .../_templates/autosummary/class_with_inherited.rst | 8 -------- docs/source/reference/crs.rst | 7 +------ 2 files changed, 1 insertion(+), 14 deletions(-) delete mode 100644 docs/source/_templates/autosummary/class_with_inherited.rst diff --git a/docs/source/_templates/autosummary/class_with_inherited.rst b/docs/source/_templates/autosummary/class_with_inherited.rst deleted file mode 100644 index ed93a2966..000000000 --- a/docs/source/_templates/autosummary/class_with_inherited.rst +++ /dev/null @@ -1,8 +0,0 @@ -{{ fullname }} -{{ underline }} - -.. currentmodule:: {{ module }} - -.. autoclass:: {{ objname }} - :members: - :inherited-members: diff --git a/docs/source/reference/crs.rst b/docs/source/reference/crs.rst index 073e7244e..49aaf06be 100644 --- a/docs/source/reference/crs.rst +++ b/docs/source/reference/crs.rst @@ -13,15 +13,10 @@ Base CRS's .. autosummary:: :toctree: generated/ - :template: autosummary/class_with_inherited.rst + :template: autosummary/class_without_inherited.rst crs.CRS crs.Globe - -.. autosummary:: - :toctree: generated/ - :template: autosummary/class_without_inherited.rst - crs.Projection crs.Geodetic crs.Geocentric