From 7440df401503fe186851dd82307517dca47ec11f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Tue, 4 Nov 2008 19:26:46 +0100 Subject: [PATCH] Fix doc conf Add introduction Set installation --- doc/conf.py | 10 +++++----- doc/index.rst | 5 +++-- doc/installation.rst | 4 ++++ doc/introduction.rst | 9 +++++++++ 4 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 doc/introduction.rst diff --git a/doc/conf.py b/doc/conf.py index 7a01570646..2462869d88 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -36,16 +36,16 @@ source_suffix = '.rst' master_doc = 'index' # General substitutions. -project = 'Tryton' +project = 'tryton' copyright = '2008, B2CK' # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. # # The short X.Y version. -version = '0.1' +version = '0.0.1' # The full version, including alpha/beta/rc tags. -release = '0.1' +release = '0.0.1' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -126,7 +126,7 @@ html_last_updated_fmt = '%b %d, %Y' #html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'Trytondoc' +htmlhelp_basename = 'trytondoc' # Options for LaTeX output @@ -141,7 +141,7 @@ htmlhelp_basename = 'Trytondoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'Tryton.tex', 'Tryton Documentation', 'Bertrand Chenal, Cédric Krier', + ('index', 'tryton.tex', 'tryton Documentation', 'Bertrand Chenal, Cédric Krier', 'manual'), ] diff --git a/doc/index.rst b/doc/index.rst index 38eb8a4069..582c0c8cc9 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -2,14 +2,15 @@ completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Tryton's documentation! -################################## +Index +##### Contents: .. toctree:: :maxdepth: 2 + introduction installation databases options diff --git a/doc/installation.rst b/doc/installation.rst index e69de29bb2..d81e4f7e48 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -0,0 +1,4 @@ +Installation +############ + +see INSTALL file. diff --git a/doc/introduction.rst b/doc/introduction.rst new file mode 100644 index 0000000000..3559826c9a --- /dev/null +++ b/doc/introduction.rst @@ -0,0 +1,9 @@ +Introduction +############ + +Tryton is a three-tiers high-level general purpose application platform +written in Python and use Postgresql as database engine. + +It is the core base of an Open Source ERP. + +It provides modularity, scalability and security.