Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Explain how to re-build the table of contents.

This commit is contained in:
Steve Howell 2016-08-27 08:39:56 -07:00 committed by Tim Abbott
parent c8e37f30d2
commit 65b884f44d
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/README.md
View File

@ -20,6 +20,11 @@ and then opening `file:///path/to/zulip/docs/_build/html/index.html` in
your browser (you can also use e.g. `firefox
docs/_build/html/index.html` from the root of your Zulip checkout).
If you are introducing a new section into the table of contents,
you will want to modify `docs/index.rst` and run `make clean` before
`make html`, so that other docs besides your new one also get the
new entry in the table of contents.
You can also usually test your changes by pushing a branch to GitHub
and looking at the content on the GitHub web UI, since GitHub renders
Markdown.