Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.02 KB

README.rst

File metadata and controls

54 lines (36 loc) · 2.02 KB

T3Docs Sample Projects

Author: Martin Bless <[email protected]>
License:CC BY 4.0 (Creative Commons)
Requires:t3docs/render-documentation:v2.4.0 or later (Docker image)
GitHub:github.com/marble/t3docs-sample-projects (repository)
TinyUrl:tinyurl.com/y53hdw3c (same github repository)
Local GitLab:gitlab.local.mbless.de
Local web:symlinked.local.mbless.de

How to start with documentation of a project

This project tries to explain various ways to start with documentation in a project from Project-001 (simplest or even none) to most advanced. This repository itself can be considered "most advanced". Project-006 is the minimal setup that's recommended for real life. Project-002 to Project-004 are just using README files. More projects are to come. Furthermore this manual contains pointers to information resources you may need for practical work.

How to render this manual

git clone https://github.com/marble/t3docs-sample-projects
cd t3docs-sample-projects
mkdir Documentation-GENERATED-temp
docker run --rm --user=$(id -u):$(id -g) \
   -v $(pwd):/PROJECT:ro \
   -v $(pwd)/Documentation-GENERATED-temp:/RESULT \
   t3docs/render-documentation \
   makehtml -c jobfile /PROJECT/Documentation/jobfile.json
firefox Documentation-GENERATED-temp/Result/project/0.0.0/Index.html

See also