Tasks #803
Tasks #802: Sphinx-based documentation
Design documentation structure for RSBag, rsb-gstreamer and related overarching topics
| Status: | Closed | Start date: | 01/16/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | - | % Done: | 100% | |
| Category: | Documentation | |||
| Target version: | - |
Related issues
Associated revisions
Added sphinx documentation in manual/*
refs #803
refs #803
- manual/conf.py: new file; sphinx configuration
- manual/Makefile: new file; autogenerated Makefile
- manual/bag-*.rst: new file; man-page-like tool documentation
- manual/*.rst: new file; generic documentation components
Added manual/CMakeLists.txt for configuration and installation
refs #802, #803
refs #802, #803
- manual/CMakeLists.txt: new file; contains code to configure
manual/conf.py and manual/Makefile.sphinx - manual/Makefile.sphinx.in: renamed manual/Makefile.sphinx ->
manual/Makefile.sphinx.in; added replacements for location of
sphinx-build program and its commandline options - manual/conf.py.in: renamed manual/conf.py -> manual/conf.py.in;
minor cleanup
Fixed links and redundancies in manual/bag-*.rst
refs #802, #803
refs #802, #803
- manual/bag-cat.rst: added proper link target for the program;
removed redundant description of common commandline options; use
code-block directive where appropriate - manual/bag-info.rst: likewise
- manual/bag-merge.rst: likewise
- manual/bag-play.rst: likewise
- manual/bag-record.rst: likewise
History
#1 Updated by J. Moringen over 12 years ago
- Status changed from New to In Progress
- % Done changed from 0 to 10
Initial experiments can be found in trunk/manual.
#2 Updated by J. Moringen about 12 years ago
- % Done changed from 10 to 60
#3 Updated by J. Moringen over 11 years ago
- Status changed from In Progress to Feedback
I think our landing page, intersphinx links, included example code, multi-project tutorials accomplished this. Can we close this?
#4 Updated by S. Wrede over 11 years ago
Yep. Please do so!
#5 Updated by J. Moringen over 11 years ago
- Status changed from Feedback to Closed
- % Done changed from 60 to 100