Skip to content

sylvainroussy/tuleap-documentation-fr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tuleap Documentation

This is a proposal to use Sphinx (instead of docbook) in order to generate the documentation for Tuleap.

This is a work in progress. Please refer to the official documentation until this becomes stable.

Build the documentations

sudo apt-get install python-pip
sudo pip install -q Sphinx
cd /path/to/tuleap-documentation
make html

The documentation is generated in _build/html/

Convert docbook files to reStructuredText

First install latest version of pandoc:

sudo apt-get install haskell-platform
cabal update
cabal install pandoc

Then convert the file from legacy documentation:

cd src/documentation/user_guide/en_US/
$HOME/.cabal/bin/pandoc -f docbook -s -w rst --toc ProjectAdministration.xml -o project-admin.rst 

Move the file if tuleap-documentation/languages/en/user-guide/ and modify the tuleap-documentation/languages/en/index.rst accordingly.

License

Tuleap and its documentation are licensed under GPLv2 or above.

About

Documentation française de Tuleap, propulsée par Sphinx

Resources

Stars

Watchers

Forks

Packages

No packages published