Skip to content

Commit ae50c79

Browse files
authored
docs: Add instructions for seeing rendered docs (spotify#1814)
1 parent f5bda8b commit ae50c79

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,14 @@ All documentation for Luigi is written in `reStructuredText/Sphinx markup
5454
code as docstrings and in `.rst`. Pull requests should come with documentation
5555
when appropriate.
5656

57-
You can check the syntax for your documentation by running
57+
You verify that your documentation code compiles by running
5858

5959
.. code:: bash
6060
6161
tox -e docs
62+
63+
After that, you can check how it renders locally with your browser
64+
65+
.. code:: bash
66+
67+
firefox doc/_build/html/index.html

0 commit comments

Comments
 (0)