Tasks #802
Sphinx-based documentation
Status: | Closed | Start date: | 01/16/2012 | |
---|---|---|---|---|
Priority: | Normal | Due date: | ||
Assignee: | J. Moringen | % Done: | 100% | |
Category: | Documentation | |||
Target version: | rsb-0.9 |
Description
This super-task is intended for tracking progress and dependencies of documentation-related sub-tasks.
Documentation is currently spread across (at least) these locations:- Wiki of Robotics Service Bus
- Wiki of RSBag
- https://code.humavips.eu/projects/scenarioy2/wiki/
- Prototypical RSB manual source:trunk/manual
- Prototypical RSBag manual project:rsbag:source:trunk/manual
Subtasks
Related issues
Associated revisions
refs #802
- manual/conf.py: removed texinfo configuration; simplified some
settings and comments
refs #802
- manual/conf.py: fixed version; added replacements for binary names
refs #802
- manual/call.rst: removed descriptions of common options; added
descriptions of --timeout and --no-wait - manual/info.rst: removed descriptions of common options; other minor
improvements - manual/logger.rst: likewise
refs #802
- manual/introduction.rst: use project text replacement
refs #802
- manual/tutorial.rst: adapted line numbers of example programs
to account for changed license headers
refs #802
- manual/glossary.rst: new file; initial glossary
- manual/index.rst: include manual/glossary.rst
refs #802
- manual/concepts.rst: use project extension text; added section on
URI schema
added intersphinx in conf.py refs #802
refs #802
- CMakeLists.txt: new file; contains code to configure conf.py and
Makefile.sphinx - Makefile.sphinx.in: renamed Makefile.sphinx -> Makefile.sphinx.in;
added replacements for location of sphinx-build program and its
commandline options - conf.py.in: renamed conf.py -> conf.py.in; minor cleanup
refs #802
- index.rst: added introduction paragraphs from introduction.rst
- introduction.rst: removed; moved content into index.rst
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
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
refs #802
- call.rst: fixed link targets; fixed heading decorations; use
code-block directive where appropriate; minor improvements - common.rst: likewise
- concepts.rst: likewise
- logger.rst: likewise
refs #802
- tutorial.rst: fixed document title; removed redundant installation
instructions; added chat examples
History
#1 Updated by J. Moringen over 12 years ago
- Description updated (diff)
#2 Updated by J. Moringen over 12 years ago
- Description updated (diff)
#3 Updated by S. Wrede over 12 years ago
I couldn't find the manual subfolder in the RSBag repository under /trunk. Is it currently checked-in?
#4 Updated by J. Moringen over 12 years ago
No, I got distracted while committing :)
Will do after coffee break.
#5 Updated by J. Moringen over 12 years ago
RSB manual is now built in job rsb-manual-trunk .
#6 Updated by J. Moringen over 12 years ago
- Status changed from New to In Progress
#7 Updated by J. Moringen over 12 years ago
RSB manual is now available at http://docs.cor-lab.org/rsb-manual/html/
#8 Updated by J. Moringen over 12 years ago
RSBag manual is now built in job rsbag-manual-trunk
RSBag manual is now available at http://docs.cor-lab.org/rsbag-manual/html/
#9 Updated by J. Moringen over 12 years ago
There is a new build job for tutorials
Initial version of video recording tutorial is available at http://docs.cor-lab.org/video-recording-and-processing/html/
#10 Updated by J. Wienke over 12 years ago
I thought we will have a general tutorial project and not specific ones per topic?
#11 Updated by J. Moringen over 12 years ago
- There is one redmine project CoR-Lab Tutorials which will contain all tutorials
- The
cor-lab-tutorials
build job is intended for building all tutorials (no integrations testing, though) and uploading the resulting artifacts todocs.cor-lab.org
#12 Updated by J. Wienke over 12 years ago
Yes, so far everything is as expected. However the deployed html documentation looks like it is only for one tutorial. I would have expected something like http://docs.cor-lab.org/tutorial and there is an overview of all tutorials as we said we will build all of them using a single sphinx project.
#13 Updated by J. Moringen over 12 years ago
Yes, the configuration, building and deployment of multiple tutorials is not yet implemented.
#14 Updated by J. Moringen over 11 years ago
Can we close this?
#15 Updated by J. Moringen over 11 years ago
- Status changed from In Progress to Feedback
I think, we can close along with #803. Any objections?
#16 Updated by J. Moringen over 11 years ago
- Status changed from Feedback to Closed
- Assignee set to J. Moringen
- Target version set to rsb-0.9