Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #1366 from shaarli/doc-setuptools-mkdocs

Browse source 
doc: CI/dev tools: add paragraph about documentation/mkdocs
This commit is contained in:
nodiscc 2019-10-02 19:57:59 +00:00 committed by GitHub
parent 5ed0d9f54d b4665de89b
commit f4c6625962
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/md/Continuous-integration-tools.md
View 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 run `make doc`.