From 954b3c81ce60246ab2c50640b51617e19ea74192 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 19 Sep 2019 19:04:05 +0000 Subject: [PATCH 1/1] doc: CI/dev tools: add paragraph about documentation/mkdocs Fixes https://github.com/shaarli/Shaarli/issues/1335 --- doc/md/Continuous-integration-tools.md | 3 +++ 1 file changed, 3 insertions(+) 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: - 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`. -- 2.41.0