Skip to content

Tuleap documentation in reStructuredText format, built with Sphinx

Notifications You must be signed in to change notification settings

captnbli/tuleap-documentation-en

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tuleap Documentation

This documentation uses Sphinx in order to generate the documentation for Tuleap.

Set-up your environment (debian)

sudo apt-get install python-pip
sudo pip install -q Sphinx

Download the sources from GitHub

git clone [email protected]:Enalean/tuleap-documentation-en.git
cd tuleap-documentation-en/

Build the documentation

make html

The documentation is generated in tuleap-documentation-en/_build/html/ You can check the modifications by opening index.html with your web browser. You need to build the documentation in order to see your modifications.

Modify/ add to the documentation

cd tuleap-documentation-en/languages/en/

There will be a few main folders in here which correspond to documentation sections. To add a new page, create the file in the correct directory then add the reference in index.rst.

Note: All changes must be pushed on the master branch.

License

Tuleap and its documentation are licensed under GPLv2 or above.

About

Tuleap documentation in reStructuredText format, built with Sphinx

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 52.0%
  • Python 23.8%
  • Makefile 19.0%
  • JavaScript 5.2%