Fix most of the reference issues throughout the docs.

Review Request #9392 — Created Nov. 19, 2017 and updated

chipx86
Djblets
release-1.0.x
1b02d00...
djblets

We have a lot of references in our docstrings and guides that
incorrectly pointed to the target. In some cases this is due to typos,
or using the full module path instead of the one provided in docs, or
old docs that didn't attempt to use the full name. There are also
__init__.py files that are importing and re-exporting classes and
functions, and these were getting picked up and causing issues.

This change fixes up most of these by turning on Sphinx's nitpick
setting and working my way through the reference issues. This does not
fix everything, partly due to issues in third-party docs and strangeness
with Sphinx, but it takes care of the big culprits we have control over.

Generated the docs with nitpick on. Saw that issues I fixed were gone,
and that the links for the ones I went through were resolving.

Description From Last Updated

Two blank lines?

daviddavid

Two blank lines.

daviddavid

While we're in here can we please change the argument name to cls?

daviddavid
david
  1. 
      
  2. djblets/avatars/services/__init__.py (Diff revision 1)
     
     

    Two blank lines?

    1. We use one elsewhere in existing modules. They're all in the same "group".

  3. djblets/forms/forms/__init__.py (Diff revision 1)
     
     

    Two blank lines.

  4. djblets/webapi/resources/registry.py (Diff revision 1)
     
     

    While we're in here can we please change the argument name to cls?

  5. 
      
chipx86
Review request changed

Change Summary:

  • Fixed up some references in djblets/webapi/resources/registry.py.
  • Renamed a klass argument to cls in the docs.

Commit:

-7b393419f6f99d0b8395e0b027f9791d349148c5
+1b02d00da02579ab5c52de23fe7feb6e019018a3

Diff:

Revision 2 (+343 -251)

Show changes

Checks run (2 succeeded)

flake8 passed.
JSHint passed.
Loading...