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.

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

Enable sphinx nitpicky on doc builds #1122

Closed
dopplershift opened this issue Aug 9, 2019 · 0 comments · Fixed by #1147
Closed

Enable sphinx nitpicky on doc builds #1122

dopplershift opened this issue Aug 9, 2019 · 0 comments · Fixed by #1147
Labels
Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality
Milestone

Comments

@dopplershift
Copy link
Member

Sphinx has a nitpicky mode that warns about missing references. This seems like something we would naturally be interested in. This can be enabled by adding to docs/conf.py:

nitpicky = True

Currently, this spews a ton of warnings that I'm not exactly sure how to fix. Here's just a sample from the end:

/Users/rmay/repos/metpy/metpy/units.py:docstring of metpy.units.pandas_dataframe_to_unit_arrays:4: WARNING: py:obj reference target not found: pandas.DataFrame
/Users/rmay/repos/metpy/docs/examples/gridding/Natural_Neighbor_Verification.rst:130: WARNING: py:func reference target not found: metpy.interpolate.geometry.find_natural_neighbors
/Users/rmay/repos/metpy/docs/units.rst:4: WARNING: py:mod reference target not found: pint
/Users/rmay/repos/metpy/docs/units.rst:34: WARNING: py:class reference target not found: pint.Quantity
/Users/rmay/repos/metpy/docs/units.rst:100: WARNING: py:class reference target not found: pint.Quantity
/Users/rmay/repos/metpy/docs/units.rst:100: WARNING: py:meth reference target not found: pint.Quantity.to
/Users/rmay/repos/metpy/docs/units.rst:100: WARNING: py:class reference target not found: pint.Quantity
/Users/rmay/repos/metpy/docs/units.rst:111: WARNING: py:meth reference target not found: pint.Quantity.ito
/Users/rmay/repos/metpy/docs/units.rst:111: WARNING: py:meth reference target not found: pint.Quantity.to_base_units
/Users/rmay/repos/metpy/docs/units.rst:124: WARNING: py:meth reference target not found: pint.Quantity.to_base_units
/Users/rmay/repos/metpy/docs/units.rst:124: WARNING: py:meth reference target not found: pint.Quantity.ito_base_units

I feel like these should be corrected if they're not resolving.

@dopplershift dopplershift added Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality labels Aug 9, 2019
@zbruick zbruick mentioned this issue Sep 5, 2019
1 task
@dopplershift dopplershift added this to the September 2022 milestone Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant