X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FContinuous-integration-tools.md;h=f7819d5adc4f669f55ac98b295bfcbc91172e212;hb=6128ab6a55430a2b705be31ff417c0c552a0db1f;hp=4bd7a0ba86d7285a4defd768c6f5dd87b8786ec8;hpb=c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 4bd7a0ba..f7819d5a 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md @@ -2,8 +2,8 @@ A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: - Documentation - generate a local HTML copy of the GitHub wiki -- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions -- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits +- [Static analysis](Static-analysis) - check that the code is compliant to PHP conventions +- [Unit tests](Unit-tests) - ensure there are no regressions introduced by new commits ## Automatic builds [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: @@ -17,7 +17,8 @@ Each build job: - updates Composer - installs 3rd-party test dependencies with Composer -- runs [Unit tests](Unit tests) +- runs [Unit tests](Unit-tests) +- runs ESLint check After all jobs have finished, Travis returns the results to GitHub: @@ -26,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`.