Tuleap uses Sphinx in order to generate its documentation.

Contributors are encouraged to have a look at Google Technical Writing course in order to add high quality content.

GitPod allows editing and building the documentation without leaving your browser. Give it a try with click on .

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

nix-shell
make html

The documentation is generated in tuleap-documentation-en/_build/html/en/ 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.

To build documentation for tuleap.org:

nix-shell
npm ci
npm run build
make SPHINXOPTS="-D html_theme=tuleap_org" html

To build the documentation in watch mode:

nix-shell
npm ci
npm run build
make SPHINXOPTS="-D html_theme=tuleap_org" watch-html

A web-server will start, the modifies pages will be rebuilt and reloaded automatically each time you save your work.

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.

Tuleap and its documentation are licensed under GPLv2 or above.