Skip to content

Commit 466b00e

Browse files
committed
Document building the documentation
1 parent 48e0d65 commit 466b00e

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

CONTRIBUTING.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Contributing to VWS Python
22
==========================
33

4+
.. contents::
5+
46
Contributions to this repository must pass tests and linting.
57

68
Travis CI is the canonical source truth.
@@ -51,13 +53,24 @@ Run ``pytest``:
5153
5254
pytest
5355
56+
Documentation
57+
-------------
58+
59+
Documentation is built on Read the Docs.
60+
61+
Run the following commands to build and view documentation locally:
62+
63+
.. code:: sh
64+
65+
make docs
66+
make open-docs
67+
5468
Travis CI
5569
---------
5670

5771
Tests are run on Travis CI.
5872
The configuration for this is in ``.travis.yml``.
5973

60-
6174
Performing a release
6275
--------------------
6376

0 commit comments

Comments
 (0)