Skip to content

Commit

Permalink
Merge pull request scipy#14844 from AnirudhDagar/doc_refguide
Browse files Browse the repository at this point in the history
DOC: Add refguide_check option details to runtests.rst
  • Loading branch information
ev-br authored Oct 12, 2021
2 parents acf966f + 25d0177 commit d378d15
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/source/dev/contributor/runtests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ Other useful options include:
docs are built only in the ``html-scipyorg`` format, but you can
change this by appending the name of the desired format
(e.g. ``--doc latex``).
- ``--refguide-check`` to check whether the objects in a Scipy submodule's
``__all__`` dict correspond to the objects included in the reference
guide. It also checks the validity of code samples in docstrings.
- ``--bench`` to run all benchmarks. See :ref:`benchmarking-with-asv`.
- ``--pep8`` to perform pep8 check.
- ``--mypy`` to run *mypy* on the codebase.
Expand Down

0 comments on commit d378d15

Please sign in to comment.