Sphinx/environment

This page aims at providing a procedure to get Sphinx sources and settle a development environment.

Setting the Eclipse environment

Before getting Sphinx, the first step consists in setting the required Eclipse environment. The principle consists in using a minimal environment for the edition, and an adapted target platform to compile and run Sphinx.

Install Eclipse

No comments.

Install a Subversion client

We recommend the use of Subversive. Subversive may be installed from the following update sites:

• http://download.eclipse.org/technology/subversive/0.7/update-site/
• http://www.polarion.org/projects/subversive/download/eclipse/2.0/update-site/

Install the following feature groups:

• Subversive SVN Team Provider Plugin (Incubation)
• Subversive SVN Connectors

SVN checkout

SVN repository configuration

Create a new SVN repository with the following attributes:

• URL: https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.sphinx (caution: https, not http)
• User: <empty>
• Password: <empty>

Import the project set

Sphinx provides a project set that lists all the Sphinx plug-ins/projects.

• Browse the SVN repository
• Check-out the project trunk/tools/org.eclipse.sphinx.psf

Import the sources

Once the project set is downloaded, it is easy to check-out the whole Sphinx project sources.

• Browse the org.eclipse.sphinx.psf project in your workspace
• Right-click on file all-subversive.psf
• Click on Import Project Set...

All the projects of Sphinx are then checked out in your workspace. They are automatically organized into several working sets.

Setting the target platform

Sphinx provides target platform definition for the two last versions of Sphinx. These target definitions are in project org.eclipse.sphinx.targetdefs, in working set Tools.

These target definitions suppose that a directory containing the target platform exists in the local file system. Our issue consists now in the recreation of this directory.

To be continued