diff options
| author | nodiscc <nodiscc@gmail.com> | 2019-09-19 19:04:05 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-19 19:04:05 +0000 |
| commit | 954b3c81ce60246ab2c50640b51617e19ea74192 (patch) | |
| tree | 55ce9b5b658e34b44aeb982a0e38cfd6a6aed7d2 | |
| parent | 1df5e9ca866cb063f234b2a99762f73edbcb6c4c (diff) | |
| download | Shaarli-954b3c81ce60246ab2c50640b51617e19ea74192.tar.gz Shaarli-954b3c81ce60246ab2c50640b51617e19ea74192.tar.zst Shaarli-954b3c81ce60246ab2c50640b51617e19ea74192.zip | |
doc: CI/dev tools: add paragraph about documentation/mkdocs
Fixes https://github.com/shaarli/Shaarli/issues/1335
| -rw-r--r-- | doc/md/Continuous-integration-tools.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 4ca6bdc7..1f379047 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md | |||
| @@ -27,3 +27,6 @@ After all jobs have finished, Travis returns the results to GitHub: | |||
| 27 | - Green: all tests have passed | 27 | - Green: all tests have passed |
| 28 | - Red: some tests failed | 28 | - Red: some tests failed |
| 29 | - Orange: tests are pending | 29 | - Orange: tests are pending |
| 30 | |||
| 31 | ## Documentation | ||
| 32 | [mkdocs](https://www.mkdocs.org/) is used to convert markdown documentation to HTML pages. The [public documentation](https://shaarli.readthedocs.io/en/master/) website is rendered and hosted by [readthedocs.org](https://readthedocs.org/). A copy of the documentation is also included in prebuilt [release archives](https://github.com/shaarli/Shaarli/releases) (`doc/html/` path in your Shaarli installation). To generate the HTML documentation locally, install a recent version of Python `setuptools` and rune `make doc`. | ||