Skip to content

Commit

Permalink
Add note about documentation to contributing section.
Browse files Browse the repository at this point in the history
  • Loading branch information
desilinguist committed Feb 20, 2020
1 parent ead89f0 commit ad35576
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/contributing.rst
Expand Up @@ -26,6 +26,12 @@ To set up a local development environment, follow the steps below:

8. Run ``nosetests -v --nologcapture tests`` to run the tests. We use the ``--nologcapture`` switch, since otherwise test failures for some tests tend to produce very long Jupyter notebook traces.

Documentation
-------------

Note that the file ``doc/requirements.txt`` is meant specifically for the ReadTheDocs documentation build process and should not be used locally. To build the documentation locally, you *must* use the same conda environment created above.


RSMTool tests
-------------

Expand Down

0 comments on commit ad35576

Please sign in to comment.