Anyone in the community can contribute to this documentation.
The project is hosted at https://github.com/mosen/profiledocs
Submitting an error¶
If you find that there is an error in the documentation, please raise an issue via Github Issues. Even better, submit a Pull Request for the correction.
The project is generated through sphinx and a plugin called sphinx-pfmanifest.
To set up for development:
- Fork this repo and clone it to your local machine.
- Install virtualenv if not present
- Create a virtual environment somewhere and activate it
- Install requirements (
pip i -r requirements.txt)
- Clone and install sphinx-pfmanifest via
python setup.py installin the sphinx-pfmanifest dir.
- Now you can make changes and run
make htmlto see the end result.