matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Split documentation and translation chapter from the development chapter of the documentation

Browse Source
This commit is contained in:
Roberto Rosario
2012-02-26 16:58:49 -04:00
parent 0667a26f2f
commit 1f1b9629e5
6 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.rst
View File

@@ -67,7 +67,7 @@ Customization and fine tunning
For developers
==============
:doc:`Development <topics/development>`
:doc:`Development <topics/development>` | :doc:`Documentation <topics/documentation>` | :doc:`Translations <topics/translations>`
Credits

2
docs/releases/0.12.rst
View File

@@ -12,7 +12,7 @@ Overview
========
Aside from new features, the focus of this release of **Mayan EDMS** also
been about improving the code quality standard
been about improving the code and documentation quality standard
even further. The permission system has been completely overhauled to make
it entire class based. The other big change is the addition of object
level permissions, with this new system being applied to documents,

31
docs/topics/development.rst
View File

@@ -51,37 +51,6 @@ To familiarize yourself with the technical details of the project read the :ref:
.. _docs:
-------------
Documentation
-------------
The documentation is written in `reStructured Text`_ format.
The documentation lives in the ``docs`` directory. In order to build it, you will first need to install Sphinx_. ::
$ pip install sphinx
Then, to build an HTML version of the documentation, simply run the following from the **docs** directory::
$ make html
Your ``docs/_build/html`` directory will then contain an HTML version of the documentation, ready for publication on most web servers.
You can also generate the documentation in format other than HTML.
.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org
------------
Translations
------------
Translations are now being handled online via the **Transifex** website: https://www.transifex.net/projects/p/mayan-edms/
To create a translation team for a new language or contribute to an already
existing language translation, create a **Transifex** account and contact
the team coordinator of the respective language in which you are interested.
---------
Debugging

21
docs/topics/documentation.rst Normal file
View File

@@ -0,0 +1,21 @@
=============
Documentation
=============
**Mayan EDMS**'s documentation is written in `reStructured Text`_ format.
The documentation lives in the ``docs`` directory. In order to build it, you will first need to install Sphinx_. ::
$ pip install sphinx
Then, to build an HTML version of the documentation, simply run the following from the **docs** directory::
$ make html
Your ``docs/_build/html`` directory will then contain an HTML version of the documentation, ready for publication on most web servers.
You can also generate the documentation in formats other than HTML.
.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org

2
docs/topics/index.rst
View File

@@ -19,3 +19,5 @@ Introductions to all the key parts of Mayan EDMS you'll need to know:
settings
customization
development
documentation
translations

8
docs/topics/translations.rst Normal file
View File

@@ -0,0 +1,8 @@
============
Translations
============
Translations are now being handled online via the **Transifex** website: https://www.transifex.net/projects/p/mayan-edms/
To create a translation team for a new language or contribute to an already
existing language translation, create a **Transifex** account and contact
the team coordinator of the respective language in which you are interested.