Browse Source

Explain how to view docs

JC Brand 6 years ago
parent
commit
ac79a0d169
1 changed files with 8 additions and 0 deletions
  1. 8 0
      docs/source/documentation.rst

+ 8 - 0
docs/source/documentation.rst

@@ -58,3 +58,11 @@ running::
 The HTMl files will be located in ``./docs/html``
 
 .. warning:: When contributing, please don't commit any generated html files.
+
+Serving the documentation
+-------------------------
+
+To view the generated docs, you can run ``make serve`` and then open
+http://localhost:8000/docs/html/index.html in your browser.
+
+