mirror of
https://github.com/NaN-tic/trydoc.git
synced 2023-12-14 02:03:42 +01:00
Removed sphinxcontrib-inheritance from requirements and updated documentation
This commit is contained in:
parent
89734ccd57
commit
e896ec5846
4
INSTALL
4
INSTALL
|
@ -1,5 +1,5 @@
|
|||
Installing proteus
|
||||
==================
|
||||
Installing trydoc
|
||||
=================
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
|
|
@ -13,6 +13,7 @@ This extension requires the following packages:
|
|||
|
||||
- Sphinx 1.0
|
||||
- proteus
|
||||
- path.py
|
||||
- tryton
|
||||
|
||||
Use ``pip`` to install this extension straight from the Python Package Index::
|
||||
|
@ -46,6 +47,40 @@ tipically). The configuration will be something like this:::
|
|||
database_type='postgresql', language='es_ES', password='admin',
|
||||
config_file='~/trytond/etc/trytond.conf')
|
||||
|
||||
|
||||
Tryton Documentation project: Provided Scripts
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want to prepare an User and/or Administrator manual, this packages
|
||||
provide some useful scripts to prepare and mantain it.
|
||||
|
||||
It have some extra requirements:
|
||||
|
||||
- **sphinxcontrib-inheritance**: another Sphinx extension (available on PyPI)
|
||||
that provides inheritance funcionality. It's used to compile the
|
||||
documentation in modular way.
|
||||
- **trytond-doc**: project with the documentation of Tryton's core (server,
|
||||
client and core modules) available on `Bitbucket
|
||||
<https://bitbucket.org/trytonspain/trytond-doc>`_.
|
||||
- **Third party modules sources**: each module should include its own
|
||||
documentation in doc/<language> directory.
|
||||
|
||||
The provided scripts:
|
||||
|
||||
- **trydoc-quickstart**: as sphinx-quickstart it helps you to prepare a new
|
||||
Sphinx project. Based on the answers during the script execution, it will
|
||||
leave the conf.py and other required files prepared.
|
||||
- **trydoc-symlinks**: put into the documentation project directory required
|
||||
symlinks to the language specific documentation of Tryton modules.
|
||||
- **trydoc-update-modules**: trydoc-quickstart prepare conf.py to get the
|
||||
*trydoc_modules* from modules.cfg. This script upates this file with the
|
||||
installed modules in specified Tryton database.
|
||||
|
||||
If you don't want to include the base documentation from *trytond-doc* project,
|
||||
you should customize the **index.rst** file generated by *trydoc-quickstart*
|
||||
scripts.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
|
|
|
@ -1,4 +1,3 @@
|
|||
path.py
|
||||
proteus
|
||||
Sphinx>=1.0b2
|
||||
sphinxcontrib-inheritance>=0.5
|
||||
|
|
Loading…
Reference in a new issue