Warning
This documentation is very much a work in progress. There are many sections that have not yet been written, and plenty of others that do not even have an entry in the contents yet.
Any help to complete this documentation would be greatly appreciated, whether that is pull requests to correct or complete parts of it, or funding to help provide more time to work on it.
This documentation repository can be used to build Tryton documentation for a
range of different purposes. It uses some sphinx extensions that allow it to
get information about a Tryton installation directly from a trytond
server, and enable it to generate documentation that is tailored to a
particular set of activated modules.
It can be found here:
This documentation repository doesn't need installing, but to generate the documentation you will need a working Python installation.
The documentation is generated by a program called Sphinx and a couple of Sphinx extensions: sphinxcontrib-inherit and sphinxcontrib-tryton. The easiest way of installing these is by using pip and the requirements.txt file that is provided:
pip install -r requirements.txtThis package is supplied with a conf.py file that is configured to attempt
to build documentation for a base Tryton system with no modules installed.
It will attempt to start and initialise a trytond service on the local
computer and then use that to obtain information about fields, modules, and
other components.
So, as a rough guide, to get you started you should:
cd tryton-documentation
python -m venv --prompt tryton-documentation .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install trytond
sphinx-build . docsThe resulting documentation will be placed in a folder called docs.
Documentation for existing systems, for a specific set of modules, and with
screenshots from the Desktop client or Web client can also be built. For this
you will need to ensure you have the right packages installed and have setup
the correct configuration in the conf.py file. See the
sphinxcontrib-tryton documentation for more details.
Any defects or issues with this documentation can be reported using the tracker: https://bitbucket.org/libateq/tryton-documentation/issues
If you are looking for printed or digital documentation that is personalised to your Tryton system, commercial support with creating or updating manuals for your system, or would just like to support the maintenance and upkeep of this documentation, then please don't hesitate to get in touch:
- Email: support@libateq.uk
- Website: https://libateq.uk/
The license details can be found in the LICENSE-fdl and LICENSE-gpl files.
The copyright notice can be found in the COPYRIGHT file.