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

Update documentation

Browse Source
This commit is contained in:
Roberto Rosario
2014-06-29 16:23:18 -04:00
parent 3c9bbb05b5
commit f835880019
6 changed files with 40 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/conf.py
View File

@@ -13,10 +13,13 @@
import sys, os
sys.path.insert(0, os.path.abspath('..'))
import mayan
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
# -- General configuration -----------------------------------------------------
@@ -37,25 +40,24 @@ templates_path = ['_templates']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'
# The master toctree document.
#master_doc = 'index'
master_doc = 'contents'
master_doc = 'index'
# General information about the project.
project = u'Mayan EDMS'
copyright = u'2011 Roberto Rosario'
project = mayan.__title__
copyright = mayan.__copyright__
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
version = mayan.__version__
# The full version, including alpha/beta/rc tags.
release = '1.0'
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -183,7 +185,7 @@ htmlhelp_basename = 'MayanEDMSdoc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('contents', 'MayanEDMS.tex', u'Mayan EDMS Documentation',
('index', 'MayanEDMS.tex', u'Mayan EDMS Documentation',
u'Roberto Rosario', 'manual'),
]
@@ -216,6 +218,6 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('contents', 'mayanedms', u'Mayan EDMS Documentation',
('index', 'mayanedms', u'Mayan EDMS Documentation',
[u'Roberto Rosario'], 1)
]

20
docs/contents.rst
View File

@@ -1,20 +0,0 @@
.. _contents:
=================================
Mayan EDMS documentation contents
=================================
.. toctree::
:hidden:
index
.. toctree::
:maxdepth: 3
intro/index
topics/index
releases/index
credits/index
faq/index

2
docs/index.rst
View File

@@ -26,8 +26,6 @@ On the Web
* Video: http://bit.ly/Mayan-Intro
* Mailing list: http://groups.google.com/group/mayan-edms/
Looking for specific information? Try the :doc:`detailed table of contents <contents>` otherwise below are the different part of the documentation.
First steps
===========

91
docs/intro/installation.rst
View File

@@ -2,8 +2,8 @@
Installation
============
Local or managed Ubuntu or Debian server
----------------------------------------
Ubuntu, Debian or Fedora server
-------------------------------
**Mayan EDMS** should be deployed_ like any other Django_ project and preferably using virtualenv_.
@@ -11,69 +11,7 @@ If using a Debian_ or Ubuntu_ based Linux distribution getting the executable re
$ sudo apt-get install python-dev gcc tesseract-ocr unpaper python-virtualenv ghostscript libjpeg-dev libpng-dev poppler-utils -y
To initialize a ``virtualenv`` to deploy the project do::
$ virtualenv --no-site-packages mayan
Download_ and decompress the latest version of **Mayan EDMS**::
$ cd mayan
$ tar -xvzf mayan.tar.gz
Or clone the latest development version straight from github::
$ cd mayan
$ git clone git://github.com/mayan-edms/mayan-edms.git
To install the python dependencies ``easy_install`` can be used, however for easier retrieval a production dependencies file is included, to use it execute::
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
Create the database that will hold the data. Install any corresponding python database drivers. Update the settings.py file with you database settings.
If using the ``MySQL`` database manager, use the following commands::
$ sudo apt-get install libmysqlclient-dev -y
$ pip install MySQL-python
If using ``PostgreSQL``, enter the following::
$ sudo apt-get install libpq-dev -y
$ pip install psycopg2
Populate the database with the project's schema doing::
$ ./manage.py syncdb --migrate --noinput
To test your installation, create a file called settings_local.py with the following content::
DEBUG=True
DEVELOPMENT=True
Execute Django’s development server using the ``runserver`` command to launch a local instance of Mayan EDMS::
$ ./manage.py runserver
Point your browser to http://127:0.0.1:8000, if everything was installed
correctly you should see the login screen. After making sure everything
is running correctly, stop the runserver command and delete the settings_local.py.
Deploy **Mayan EDMS** using the webserver of your preference. If your are
using Apache_, a sample site file is included under the contrib directory.
Before finally deploying to your favorite webserver don't forget to collect the
static files of the project into the ``static`` folder for serving via a webserver::
$ ./manage.py collectstatic
Local or managed Fedora server
------------------------------
**Mayan EDMS** should be deployed_ like any other Django_ project and preferably using virtualenv_.
If using a Fedora_ based Linux distribution getting the executable requirements is as easy as::
If using a Fedora_ based Linux distribution get the executable requirements using Yum::
$ sudo yum install -y git gcc tesseract unpaper python-virtualenv ghostscript libjpeg-turbo-devel libpng-devel poppler-util python-devel
@@ -95,11 +33,21 @@ To install the python dependencies ``easy_install`` can be used, however for eas
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
$ pip install -r requirements.txt
Create the database that will hold the data. Install any corresponding python database drivers. Update the settings.py file with you database settings.
If using the ``MySQL`` database manager, use the following commands::
$ sudo apt-get install libmysqlclient-dev -y
$ pip install MySQL-python
If using ``PostgreSQL``, enter the following::
$ sudo apt-get install libpq-dev -y
$ pip install psycopg2
For Fedora systems just use Yum instead of APT::
$ sudo yum install -y mysql-devel
$ pip install MySQL-python
@@ -112,12 +60,7 @@ Populate the database with the project's schema doing::
$ ./manage.py syncdb --migrate --noinput
To test your installation, create a file called settings_local.py with the following content::
DEBUG=True
DEVELOPMENT=True
Execute Django’s development server using the ``runserver`` command to launch a local instance of Mayan EDMS::
To test your installation, execute Django’s development server using the ``runserver`` command to launch a local instance of Mayan EDMS::
$ ./manage.py runserver
@@ -171,7 +114,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
$ git clone git://github.com/mayan-edms/mayan-edms.git
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
$ pip install -r requirements.txt
4. Install the Python MySQL database driver::
@@ -248,8 +191,6 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
apache2/bin/restart
.. _`vendor lock-in`: https://secure.wikimedia.org/wikipedia/en/wiki/Vendor_lock-in
.. _Python: http://www.python.org/
.. _Django: http://www.djangoproject.com/

6
docs/releases/1.0.rst
View File

@@ -100,6 +100,12 @@ These files are now part of their own project.
Pluggable OCR backends
~~~~~~~~~~~~~~~~~~~~~~
License change
~~~~~~~~~~~~~~
Mayan EDMS is now licensed under the Apache 2.0 license. This means many
things but the main change is that inclusion of Mayan EDMS into
commercial products is now explicitly allowed.
Upgrading from a previous version
=================================
If you installed **Mayan EDMS** by cloning the Git repository issue the commands::

7
mayan/__init__.py
View File

@@ -1 +1,6 @@
__version__ = '1.0.0beta2'
__title__ = 'Mayan EDMS'
__version__ = '1.0.0'
__build__ = 0x010000
__author__ = 'Roberto Rosario'
__license__ = 'Apache 2.0'
__copyright__ = 'Copyright 2011 Roberto Rosario'