X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FContinuous-integration-tools.md;h=f7819d5adc4f669f55ac98b295bfcbc91172e212;hb=6128ab6a55430a2b705be31ff417c0c552a0db1f;hp=4ca6bdc7aab9cf503b2de1ee90f1636e12ec1e8d;hpb=a1a15ac37b779ba9202095c721bc60a106348dd4;p=github%2Fshaarli%2FShaarli.git 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: - 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 run `make doc`.