Commit Graph

20 Commits

Author SHA1 Message Date
Willi Eggeling cc8f572bc0 migrated Github wiki links to readthedocs 2017-08-26 09:40:57 +02:00
VirtualTam d3fee4f40b documentation: update installation instructions for 0.9.1
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-23 01:22:07 +02:00
VirtualTam 92ccaea470 documentation: fix list formatting
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-23 00:57:50 +02:00
VirtualTam 57c628e195 documentation: update 3rd-party resources
Relates to https://github.com/shaarli/Shaarli/issues/915

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-08 22:02:50 +02:00
VirtualTam f320efd689 documentation: elaborate on REST API server & client prerequisites
Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:46:05 +02:00
VirtualTam 23daed648c documentation: remove obsolete doc release instructions
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:33:07 +02:00
VirtualTam 61f63d1086 documentation: add links to example REST API clients
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:30:43 +02:00
VirtualTam e62486dd6a documentation: rewrite the REST API PHP client example
Closes https://github.com/shaarli/Shaarli/issues/905
Relates to https://github.com/shaarli/Shaarli/pull/751
See https://shaarli.github.io/api-documentation/

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:15:59 +02:00
VirtualTam 7f876cf62b documentation: update release download and usage information
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 12:08:09 +02:00
VirtualTam 28439d63b8 documentation: remove duplicate "Coding guidelines" page
The information is already present under "Static analysis"

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 12:05:15 +02:00
VirtualTam 43ad7c8e82 documentation: fix rendering and internal references
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>
2017-08-05 11:56:24 +02:00
VirtualTam fcd900f7ce documentation: remove uneeded resources
Relates to https://github.com/shaarli/Shaarli/issues/312
Relates to https://github.com/shaarli/Shaarli/pull/772

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:48:41 +02:00
VirtualTam 84d0632a2d docker: remove `dev` image, update documentation
Relates to https://github.com/shaarli/Shaarli/issues/843

Changed:
- Update Docker image list
- Update Docker documentation structure

Removed:
- Delete Dockerfile and resources for the `dev` image
- Cleanup `doc/` resources

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-07-29 15:32:22 +02:00
nodiscc 6d074b4c90 doc: fix bullet list formatting
https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
2017-07-20 19:52:39 +02:00
nodiscc 2f9c1ecf88 doc: release: update doc generation instructions 2017-07-04 21:26:01 +02:00
nodiscc 081a73486f doc: replace pandoc requirement with python3-venv 2017-06-18 22:22:34 +02:00
nodiscc 12e1877917 move README contents to doc/md/index.md 2017-06-18 22:15:50 +02:00
nodiscc 0433c688b9 make htmlpages 2017-06-18 06:32:30 +02:00
nodiscc 460ce50115 doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md 2017-06-18 06:29:15 +02:00
nodiscc 53ed6d7d1e 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
2017-06-18 00:19:49 +02:00