diff options
| author | Joseph Herlant <aerostitch@debian.org> | 2019-10-28 09:19:31 -0700 |
|---|---|---|
| committer | Joseph Herlant <aerostitch@debian.org> | 2019-10-28 09:19:31 -0700 |
| commit | a1fba11ce9fa87368fa701029f05540652deea1a (patch) | |
| tree | d7bae631365e1fd9b1dfa17984b6e1eaeb74bebf | |
| parent | 5ff73784e1e4a8b589ecf0b8965530e918f28e06 (diff) | |
| download | navit-a1fba11ce9fa87368fa701029f05540652deea1a.tar.gz | |
Add how to view the rendered doc
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a52684188..9f7d5d4b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,9 +71,14 @@ message explaining the change. You can use the following command from the root of the git repository clone to check the linting of the documentation (The last argument is the output directory so you might have to adjust that) if you have `sphinx-build` installed: ``` +mkdir /tmp/navit sphinx-build -Dhtml_theme="sphinx_rtd_theme" -n -E -W --keep-going docs /tmp/navit/ ``` +Now if you want to view how the result would look like you can run an http server on the directory you created the build +(`/tmp/navit/` in the previously mentionned command) using: `python3 -m http.server 8000` and then call +<http://localhost:8000> from your browser. + ## See also * [programming guidelines](https://navit.readthedocs.io/en/trunk/development/programming_guidelines.html) |