From d4bbd3d0d32ad6864552bf565b32be25f0f119ba Mon Sep 17 00:00:00 2001 From: zssherman Date: Mon, 3 Feb 2020 12:31:36 -0600 Subject: [PATCH] DOC: Some documentation changes for new sphinx napoleon that was missed in previous pull request. --- .gitignore | 3 +-- README.rst | 7 ++----- doc/source/contributors_guide.rst | 23 ++++------------------- guides/contributors_guide.rst | 22 +++------------------- pyart/retrieve/kdp_proc.py | 1 - pyart/retrieve/vad.py | 6 +++--- 6 files changed, 13 insertions(+), 49 deletions(-) diff --git a/.gitignore b/.gitignore index a50bc5fb93..c973778c48 100644 --- a/.gitignore +++ b/.gitignore @@ -97,8 +97,7 @@ pyart/retrieve/_echo_steinermodule.c # Documentation files # ####################### /doc/build -/doc/source/user_reference/generated -/doc/source/dev_reference/generated +/doc/source/API/generated /doc/source/auto_examples # radar data files # diff --git a/README.rst b/README.rst index 56302ea948..06481b4c93 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ The Python ARM Radar Toolkit (Py-ART) |AnacondaCloud| |CondaDownloads| -|DocsDev| |DocsUsers| |DocsGuides| +|DocsUsers| |DocsGuides| |ARM| |Tweet| @@ -22,11 +22,8 @@ The Python ARM Radar Toolkit (Py-ART) .. |CondaDownloads| image:: https://anaconda.org/conda-forge/arm_pyart/badges/downloads.svg :target: https://anaconda.org/conda-forge/arm_pyart/files -.. |DocsDev| image:: https://img.shields.io/badge/docs-developers-4088b8.svg - :target: http://arm-doe.github.io/pyart-docs-travis/dev_reference/index.html - .. |DocsUsers| image:: https://img.shields.io/badge/docs-users-4088b8.svg - :target: http://arm-doe.github.io/pyart-docs-travis/user_reference/index.html + :target: http://arm-doe.github.io/pyart-docs-travis/API/index.html .. |DocsGuides| image:: https://img.shields.io/badge/docs-guides-4088b8.svg :target: https://github.com/ARM-DOE/pyart/tree/master/guides/ diff --git a/doc/source/contributors_guide.rst b/doc/source/contributors_guide.rst index 3ccb4318e1..470951ad99 100644 --- a/doc/source/contributors_guide.rst +++ b/doc/source/contributors_guide.rst @@ -115,30 +115,15 @@ the tools documentation for details on this process. Python File Setup ----------------- -In a new .py file, the top of the code should have the function or class -location, sphinx comments for template configuration, and the public and -private functions and classes within the .py file. Public functions and -classes are listed first and then private functions and classes. Private -functions and classes should have a underscore in front of the name. A space -is needed between the last function or class and the closing docstring -quotation. +In a new .py file, the top of the code should have a brief introduction to +the module. An example: .. code-block:: python - + """ - pyart.retrieve.velocity_azimuth_display - ======================================= - - Retrieval of VADs from a radar object. - - .. autosummary:: - :toctree generated/ - - velocity_azimuth_display - _inverse_dist_squared - _Average1D + Retrieval of VADs from a radar object. """ diff --git a/guides/contributors_guide.rst b/guides/contributors_guide.rst index da81f69647..cc188ffbcb 100644 --- a/guides/contributors_guide.rst +++ b/guides/contributors_guide.rst @@ -117,31 +117,15 @@ the tools documentation for details on this process. Python File Setup ----------------- -In a new .py file, the top of the code should have the function or class -location, sphinx comments for template configuration, and the public and -private functions and classes within the .py file. Public functions and -classes are listed first and then private functions and classes. Private -functions and classes should have a underscore in front of the name. A space -is needed between the last function or class and the closing docstring -quotation. +In a new .py file, the top of the code should have a brief introduction to +the module. An example: .. code-block:: python """ - pyart.retrieve.velocity_azimuth_display - ======================================= - - Retrieval of VADs from a radar object. - - .. autosummary:: - :toctreeL generated/ - :template: dev_template.rst - - velocity_azimuth_display - _inverse_dist_squared - _Average1D + Retrieval of VADs from a radar object. """ diff --git a/pyart/retrieve/kdp_proc.py b/pyart/retrieve/kdp_proc.py index 95b1e6ee53..3ca17cbe5e 100755 --- a/pyart/retrieve/kdp_proc.py +++ b/pyart/retrieve/kdp_proc.py @@ -88,7 +88,6 @@ def kdp_schneebeli(radar, gatefilter=None, fill_value=None, psidp_field=None, 5137-5149, doi:10.1109/TGRS.2013.2287017, 2014. """ - # create parallel computing instance if parallel: import multiprocessing as mp diff --git a/pyart/retrieve/vad.py b/pyart/retrieve/vad.py index 009e4c76bb..fd523196ab 100644 --- a/pyart/retrieve/vad.py +++ b/pyart/retrieve/vad.py @@ -33,12 +33,12 @@ def velocity_azimuth_display(radar, vel_field=None, z_want=None, Returns ------- - vad: HorizontalWindProfile + vad : HorizontalWindProfile A velocity azimuth display object containing height, speed, direction, u_wind, v_wind from a radar object. - Reference - --------- + References + ---------- Michelson, D. B., Andersson, T., Koistinen, J., Collier, C. G., Riedl, J., Szturc, J., Gjertsen, U., Nielsen, A. and Overgaard, S. (2000) BALTEX Radar Data Centre Products and their Methodologies. In SMHI Reports. Meteorology