Documentation updates. Add screenshots chapter.

This commit is contained in:
Roberto Rosario
2015-12-02 04:09:49 -04:00
parent 6ef9b25e74
commit d62ee8ad19
12 changed files with 136 additions and 23 deletions

View File

@@ -357,9 +357,9 @@ Likewise, to see the debug output of the ``tags`` app, just add the following in
Documentation
-------------
The documentation is written in `reStructured Text`_ format and resides in the
``docs`` directory. In order to build it, you will first need to install the
documentation editing dependencies (Sphinx_, etc)::
The documentation is written in `reStructured Text`_ format, processed with
Sphinx_, and resides in the ``docs`` directory. In order to build it, you will
first need to install the documentation editing dependencies with::
pip install -r requirements/documentation.txt
@@ -368,10 +368,11 @@ from the **docs** directory::
make livehtml
The ``docs/_build/html`` directory will then contain an HTML version of the
documentation.
The generated documentation can be viewed by browsing to http://127.0.0.1:8000
or by browsing to the ``docs/_build/html`` directory.
You can also generate the documentation in formats other than HTML.
You can also generate the documentation in formats other than HTML. Consult the
Sphinx_ documentation for more details.
.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org

View File

@@ -19,3 +19,4 @@ Introductions to all the key parts of **Mayan EDMS** you'll need to know:
smart_links
tags
file_storage
screenshots

View File

@@ -0,0 +1,64 @@
===========
Screenshots
===========
.. figure:: /_static/main.png
:figwidth: 40%
:scale: 30 %
:alt: Home screen
:align: left
Home screen
.. figure:: /_static/page_view.png
:figwidth: 40%
:scale: 30 %
:alt: Page view
:align: right
Page view
.. figure:: /_static/document_view.png
:figwidth: 40%
:scale: 30 %
:alt: Document view
:align: left
Document view
.. figure:: /_static/api.png
:figwidth: 40%
:scale: 30 %
:alt: REST API
:align: right
REST API
.. figure:: /_static/tools.png
:figwidth: 40%
:scale: 30 %
:alt: Tools
:align: left
Tools
.. figure:: /_static/setup.png
:figwidth: 40%
:scale: 30 %
:alt: Setup
:align: right
Setup
.. figure:: /_static/statistics.png
:figwidth: 40%
:scale: 30 %
:alt: Statistics
:align: left
Statistics