diff --git a/docs/index.rst b/docs/index.rst index c7ffad1fde..0079a21776 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -67,7 +67,7 @@ Customization and fine tunning For developers ============== - :doc:`Development ` + :doc:`Development ` | :doc:`Documentation ` | :doc:`Translations ` Credits diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index b0059814bc..d382caf9cb 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -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, diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 8521d397af..84f4389653 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -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 diff --git a/docs/topics/documentation.rst b/docs/topics/documentation.rst new file mode 100644 index 0000000000..9c6af6e058 --- /dev/null +++ b/docs/topics/documentation.rst @@ -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 diff --git a/docs/topics/index.rst b/docs/topics/index.rst index f650be46fc..b5ca990d6b 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -19,3 +19,5 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: settings customization development + documentation + translations diff --git a/docs/topics/translations.rst b/docs/topics/translations.rst new file mode 100644 index 0000000000..0dc2daf1bf --- /dev/null +++ b/docs/topics/translations.rst @@ -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.