diff options
| author | nodiscc <nodiscc@gmail.com> | 2019-10-02 19:57:59 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-02 19:57:59 +0000 |
| commit | f4c662596225cbd83eba95ced8d183877c7ed5ff (patch) | |
| tree | ec739faf7f5209a4e6627d1114e4d71fc1ec0514 | |
| parent | 5ed0d9f54d353dd5b4b5c7e61d1666e55e4532ed (diff) | |
| parent | b4665de89b3038d4699ba588ae219bb4e276202c (diff) | |
| download | Shaarli-f4c662596225cbd83eba95ced8d183877c7ed5ff.tar.gz Shaarli-f4c662596225cbd83eba95ced8d183877c7ed5ff.tar.zst Shaarli-f4c662596225cbd83eba95ced8d183877c7ed5ff.zip | |
Merge pull request #1366 from shaarli/doc-setuptools-mkdocs
doc: CI/dev tools: add paragraph about documentation/mkdocs
| -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..f7819d5a 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 run `make doc`. | ||