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

DOC: Some documentation changes for new sphinx napoleon that was missed in previous pull request. #902

Merged
merged 1 commit into from
Feb 3, 2020
+13 −49
Merged

DOC: Some documentation changes for new sphinx napoleon that was missed in previous pull request. #902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 #
Expand Down
7 changes: 2 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Python ARM Radar Toolkit (Py-ART)

|AnacondaCloud| |CondaDownloads|

|DocsDev| |DocsUsers| |DocsGuides|
|DocsUsers| |DocsGuides|

|ARM| |Tweet|

Expand All @@ -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/
Expand Down
23 changes: 4 additions & 19 deletions doc/source/contributors_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

"""

Expand Down
22 changes: 3 additions & 19 deletions guides/contributors_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

"""

Expand Down
1 change: 0 additions & 1 deletion pyart/retrieve/kdp_proc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions pyart/retrieve/vad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down