Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | migrated Github wiki links to readthedocs | Willi Eggeling | 2017-08-26 | 1 | -1/+1 |
| | |||||
* | documentation: fix rendering and internal references | VirtualTam | 2017-08-05 | 1 | -3/+3 |
| | | | | | | | | | | | | | | | | | | | This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam <virtualtam@flibidi.net> | ||||
* | Generate HTML documentation using MkDocs (WIP) | nodiscc | 2017-06-18 | 1 | -0/+75 |
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 |