From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: 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 --- doc/md/Continuous-integration-tools.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/md/Continuous-integration-tools.md (limited to 'doc/md/Continuous-integration-tools.md') 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 @@ +## Local development +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]] - check that the code is compliant to PHP conventions +- [[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: +- each time a commit is merged to the mainline (`master` branch) +- each time a Pull Request is submitted or updated + +A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). + +Each build job: +- updates Composer +- installs 3rd-party test dependencies with Composer +- runs [[Unit tests]] + +After all jobs have finished, Travis returns the results to GitHub: +- a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) +- Pull Requests are updated with the Travis result + - Green: all tests have passed + - Red: some tests failed + - Orange: tests are pending -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/md/Continuous-integration-tools.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/md/Continuous-integration-tools.md') diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 30dc474d..849257f7 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md @@ -1,20 +1,20 @@ ## Local development 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]] - check that the code is compliant to PHP conventions -- [[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: - each time a commit is merged to the mainline (`master` branch) - each time a Pull Request is submitted or updated -A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). +A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). Each build job: - updates Composer - installs 3rd-party test dependencies with Composer -- runs [[Unit tests]] +- runs [Unit tests](Unit tests) After all jobs have finished, Travis returns the results to GitHub: - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) -- cgit v1.2.3