From e896ec5846bbdca37e873af70e519432cf2202ca Mon Sep 17 00:00:00 2001 From: guillemNaN Date: Sun, 10 Nov 2013 10:32:41 +0100 Subject: [PATCH] Removed sphinxcontrib-inheritance from requirements and updated documentation --- INSTALL | 4 ++-- doc/index.rst | 35 +++++++++++++++++++++++++++++++++++ requirements.txt | 1 - setup.py | 1 - 4 files changed, 37 insertions(+), 4 deletions(-) diff --git a/INSTALL b/INSTALL index 4267630..af69b22 100644 --- a/INSTALL +++ b/INSTALL @@ -1,5 +1,5 @@ -Installing proteus -================== +Installing trydoc +================= Prerequisites ------------- diff --git a/doc/index.rst b/doc/index.rst index e64e045..70817ed 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 + `_. +- **Third party modules sources**: each module should include its own + documentation in doc/ 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 ----- diff --git a/requirements.txt b/requirements.txt index 8abda8b..dbada67 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ path.py proteus Sphinx>=1.0b2 -sphinxcontrib-inheritance>=0.5 diff --git a/setup.py b/setup.py index 6b4575e..b12ec3f 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,6 @@ requires = [ 'path.py', 'proteus', 'Sphinx>=1.0b2', - 'sphinxcontrib-inheritance>=0.5', ] setup(