diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Continuous-integration-tools.md | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip |
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.
* http://www.mkdocs.org/
* http://www.mkdocs.org/user-guide/configuration/
Ref. #312
* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
* generate HTML doc in doc/html
* add pages TOC/ordering
* use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation
Diffstat (limited to 'doc/md/Continuous-integration-tools.md')
-rw-r--r-- | doc/md/Continuous-integration-tools.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md new file mode 100644 index 00000000..30dc474d --- /dev/null +++ b/doc/md/Continuous-integration-tools.md | |||
@@ -0,0 +1,24 @@ | |||
1 | ## Local development | ||
2 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: | ||
3 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
4 | - [[Static analysis]] - check that the code is compliant to PHP conventions | ||
5 | - [[Unit tests]] - ensure there are no regressions introduced by new commits | ||
6 | |||
7 | ## Automatic builds | ||
8 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: | ||
9 | - each time a commit is merged to the mainline (`master` branch) | ||
10 | - each time a Pull Request is submitted or updated | ||
11 | |||
12 | A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). | ||
13 | |||
14 | Each build job: | ||
15 | - updates Composer | ||
16 | - installs 3rd-party test dependencies with Composer | ||
17 | - runs [[Unit tests]] | ||
18 | |||
19 | After all jobs have finished, Travis returns the results to GitHub: | ||
20 | - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) | ||
21 | - Pull Requests are updated with the Travis result | ||
22 | - Green: all tests have passed | ||
23 | - Red: some tests failed | ||
24 | - Orange: tests are pending | ||