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/Development.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/Development.md')
-rw-r--r-- | doc/Development.md | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/doc/Development.md b/doc/Development.md deleted file mode 100644 index 6cfcb683..00000000 --- a/doc/Development.md +++ /dev/null | |||
@@ -1,35 +0,0 @@ | |||
1 | #Development | ||
2 | ## Guidelines | ||
3 | Please have a look at the following pages: | ||
4 | - [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)[](.html) | ||
5 | - [Static analysis](Static-analysis.html) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: | ||
6 | - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard[](.html) | ||
7 | - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide[](.html) | ||
8 | - [Unit tests](Unit-tests.html) | ||
9 | - [GnuPG signature](GnuPG-signature.html) for tags/releases | ||
10 | |||
11 | ## Continuous integration tools | ||
12 | ### Local development | ||
13 | A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations:[](.html) | ||
14 | - Documentation - generate a local HTML copy of the GitHub wiki | ||
15 | - [Static analysis](Static-analysis.html) - check that the code is compliant to PHP conventions | ||
16 | - [Unit tests](Unit-tests.html) - ensure there are no regressions introduced by new commits | ||
17 | |||
18 | ### Automatic builds | ||
19 | [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build:[](.html) | ||
20 | - each time a commit is merged to the mainline (`master` branch) | ||
21 | - each time a Pull Request is submitted or updated | ||
22 | |||
23 | A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server-requirements.html)). | ||
24 | |||
25 | Each build job: | ||
26 | - updates Composer | ||
27 | - installs 3rd-party test dependencies with Composer | ||
28 | - runs [Unit tests](Unit-tests.html) | ||
29 | |||
30 | After all jobs have finished, Travis returns the results to GitHub: | ||
31 | - a status icon represents the result for the `master` branch: [![(https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli)]((https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli).html) | ||
32 | - Pull Requests are updated with the Travis result | ||
33 | - Green: all tests have passed | ||
34 | - Red: some tests failed | ||
35 | - Orange: tests are pending | ||