Bug #1283

RST-Manual is inconsistent about the right PYTHONPATH

Added by D. Klotz over 11 years ago. Updated over 11 years ago.

Status:ResolvedStart date:12/06/2012
Priority:NormalDue date:
Assignee:J. Moringen% Done:

100%

Category:documentation
Target version:Robotics Service Bus - rsb-0.9

Description

Both the trunk and the 0.7 versions of the RST manual contain inconsistent (and partly wrong/misleading) information on how to set the right PYTHONPATH to use the rst modules from Python.

In the Preparation > Installing RST section there is a note saying that the site-packages folder of the install $prefix should be on the PYTHONPATH, the tutorial correctly tells us to put the .eggs themselves on the path (although the 0.7 tutorial incorrectly uses "0.8" in the example file names given).

Associated revisions

Revision 5d62e8e3
Added by J. Moringen over 11 years ago

Describe installation and usage separately and only in one place

refs #1283

preparation.rst and user-tutorial.rst both used to describe setting up
PYTHONPATH. Also, the description in preparation.rst was wrong.

  • install.rst: renamed preparation.rst -> install.rst; added link to
    language-specific usage tutorials; removed usage instructions for
    Python; removed sections "Preparation", "Testing the Installation"
    and "Troubleshooting", these can become separate documents
  • user-tutorial.rst: added link targets for language-specific sections
  • index.rst: changed include preparation.rst -> install.rst
  • _templates/page.html: adapted to above changes

Revision 67edde6e
Added by D. Klotz over 11 years ago

Corrected some instructions about how to set the PYTHONPATH. refs #1283

History

#1 Updated by J. Moringen over 11 years ago

  • Status changed from New to Resolved
  • Target version set to rsb-0.9
  • % Done changed from 0 to 100

Also available in: Atom PDF