Tasks #802

Sphinx-based documentation

Added by J. Moringen over 12 years ago. Updated over 11 years ago.

Status:ClosedStart date:01/16/2012
Priority:NormalDue 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: reStructuredText Resources

Subtasks

Tasks #803: Design documentation structure for RSBag, rsb-gstreamer a...Closed


Related issues

Related to Robotics Service Bus - Enhancement #779: Evaluate if Sphinx is a Basis for Better Concept, Install... Resolved 12/21/2011

Associated revisions

Revision eb6f9ca4
Added by J. Moringen over 12 years ago

Minor fixes and simplifications in manual/conf.py
refs #802
  • manual/conf.py: removed texinfo configuration; simplified some
    settings and comments

Revision 42202629
Added by J. Moringen over 12 years ago

Fixed version in manual/conf.py
refs #802
  • manual/conf.py: fixed version; added replacements for binary names

Revision ce86cacb
Added by J. Moringen over 12 years ago

Added option description in manual/common.rst
refs #802, #805
  • manual/common.rst: new file; contains description of common
    commandline options
  • manual/tools.rst: include manual/common.rst

Revision 84552d91
Added by J. Moringen over 12 years ago

Improved option descriptions in manual/{call,info,logger}.rst
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

Revision aec318c0
Added by J. Moringen over 12 years ago

Use project replacement in manual/introduction.rst
refs #802
  • manual/introduction.rst: use project text replacement

Revision 3f91bbfd
Added by J. Moringen over 12 years ago

Adapted example line numbers in manual/tutorial.rst
refs #802
  • manual/tutorial.rst: adapted line numbers of example programs
    to account for changed license headers

Revision ea09cd6f
Added by J. Moringen over 12 years ago

Added glossary in manual/glossary.rst
refs #802
  • manual/glossary.rst: new file; initial glossary
  • manual/index.rst: include manual/glossary.rst

Revision d1dda6c8
Added by J. Moringen over 12 years ago

Replacement text and extensions in manual/concepts.rst
refs #802
  • manual/concepts.rst: use project extension text; added section on
    URI schema

Revision 83367ba1
Added by J. Moringen over 12 years ago

added intersphinx in conf.py refs #802

Revision 5a5e7227
Added by J. Moringen over 12 years ago

Added CMakeLists.txt for configuration and installation
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

Revision 8cb77c56
Added by J. Moringen over 12 years ago

Moved introduction in index.rst
refs #802
  • index.rst: added introduction paragraphs from introduction.rst
  • introduction.rst: removed; moved content into index.rst

Revision 69d69cda
Added by J. Moringen over 12 years ago

Added manual/CMakeLists.txt for configuration and installation
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

Revision d2a45a3b
Added by J. Moringen over 12 years ago

Moved introduction in manual/index.rst
refs #802, #803
  • manual/index.rst: added introduction paragraphs from
    manual/introduction.rst
  • manual/introduction.rst: removed; moved content into
    manual/index.rst

Revision 3c25d1e7
Added by J. Moringen over 12 years ago

Fixed links and redundancies in manual/bag-*.rst
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

Revision 531d2b62
Added by J. Moringen over 12 years ago

Fixed links, minor improvements in *.rst
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

Revision fed2d1e0
Added by J. Moringen almost 12 years ago

Fixed and extended tutorial.rst
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

This is the case, if I understood our plan correctly:
  • 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 to docs.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

Also available in: Atom PDF