]> git.immae.eu Git - github/shaarli/Shaarli.git/commitdiff
doc: CI/dev tools: add paragraph about documentation/mkdocs
authornodiscc <nodiscc@gmail.com>
Thu, 19 Sep 2019 19:04:05 +0000 (19:04 +0000)
committerGitHub <noreply@github.com>
Thu, 19 Sep 2019 19:04:05 +0000 (19:04 +0000)
Fixes https://github.com/shaarli/Shaarli/issues/1335

doc/md/Continuous-integration-tools.md

index 4ca6bdc7aab9cf503b2de1ee90f1636e12ec1e8d..1f379047bae9102c9420193cfcc6b81c5fa9551f 100644 (file)
@@ -27,3 +27,6 @@ After all jobs have finished, Travis returns the results to GitHub:
     - Green: all tests have passed
     - Red: some tests failed
     - Orange: tests are pending
+
+## Documentation
+[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`.