Tasks #1060

Cross-reference individual manuals

Added by J. Moringen almost 12 years ago. Updated almost 12 years ago.

Status:ResolvedStart date:07/06/2012
Priority:NormalDue date:
Assignee:-% Done:

100%

Category:Documentation
Target version:rsb-0.7

Description

Sphinx can place custom links in the sidebar area of manuals.

This can be achieved via customization of Shpinx template/configuration.

Related issues

Related to Robotics Service Bus - Tasks #900: Finalize initial version of RSB manual Resolved 07/13/2012
Related to Compliant Control Architecture - Tasks #1089: Cross-reference individual manuals Resolved 07/19/2012

Associated revisions

Revision fa1b993a
Added by J. Moringen almost 12 years ago

Added links to other documentation; Improved CMake code
refs #1060
  • CMakeLists.txt: removed unnecessary prefixes in variable names;
    added explicit targets which invoke sphinx-build for html, pdf and
    man
  • conf.py.in: configure html sidebars; expect templates in build
    directory
  • _templates/layout.html.in: new file; adds links to HTML head
  • _templates/rsblinks.html.in: new file; adds links to sidebar
  • Makefile.sphinx.in: removed; no longer necessary

Revision 563de2c6
Added by J. Moringen almost 12 years ago

Added links to other documentation; Improved CMake code
refs #1060
  • CMakeLists.txt: removed unnecessary prefixes in variable names;
    added explicit targets which invoke sphinx-build for html, pdf and
    man
  • conf.py.in: configure html sidebars; expect templates in build
    directory
  • _templates/layout.html.in: new file; adds links to HTML head
  • _templates/rsblinks.html.in: new file; adds links to sidebar
  • Makefile.sphinx.in: removed; no longer necessary

Revision 660f2b7d
Added by J. Moringen almost 12 years ago

Added links to other documentation; Improved CMake code
refs #1060
  • CMakeLists.txt: removed unnecessary prefixes in variable names;
    added explicit targets which invoke sphinx-build for html, pdf and
    man
  • conf.py.in: configure html sidebars; expect templates in build
    directory
  • _templates/layout.html.in: new file; adds links to HTML head
  • _templates/rsblinks.html.in: new file; adds links to sidebar
  • Makefile.sphinx.in: removed; no longer necessary
  • .gitignore: adapted to changed build process

History

#1 Updated by J. Moringen almost 12 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 50

#2 Updated by J. Moringen almost 12 years ago

  • Subject changed from Cross-reference individual manuls to Cross-reference individual manuals

#3 Updated by J. Moringen almost 12 years ago

  • Status changed from In Progress to Resolved
  • Target version changed from rsb-0.9 to rsb-0.7
  • % Done changed from 50 to 100

Also available in: Atom PDF