Homec4science
Diffusion invenio-infoscience (maint-2.1) Browse

R3600/docs/index.rst
2d4a028809a8maint-2.1

Last Change
Raw File

index.rst
View Options

.. This file is part of Invenio
Copyright (C) 2014 CERN.
Invenio is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
Invenio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with Invenio; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
:orphan:
=====================
Invenio documentation
=====================
.. image:: _static/logo-full.png
:alt: Invenio: digital repository software
:class: pull-right
Welcome to Invenio's documentation. This documentation is divided into
different parts. We recommend that you get started with
:ref:`first-steps` and then head over to the :ref:`quickstart`.
Besides the quickstart, there is also a more detailed :ref:`tutorial` that
shows how to create a complete application with Invenio. If
you'd rather dive into the internals of Invenio, check out
the :ref:`api` documentation. Common patterns are described in the
:ref:`patterns` section.
Invenio depends on several external libraries:
- the `Flask`_ microframework for Python (based on `Werkzeug`_ and `Jinja2`_),
- the `Jinja2`_ template engine,
- the `Werkzeug`_ WSGI toolkit,
- the `SQLAlchemy`_ SQL toolkit and Object Relational Mapper.
These libraries are not documented here. If you want to dive into their
documentation, check out the following links:
- `Flask Documentation <http://flask.pocoo.org/documentation/>`_
- `Jinja2 Documentation <http://jinja.pocoo.org/docs/>`_
- `Werkzeug Documentation <http://werkzeug.pocoo.org/documentation/>`_
- `SQLAlchemy Documentation <http://docs.sqlalchemy.org/en/latest/>`_
.. _Flask: http://flask.pocoo.org/
.. _Jinja2: http://jinja.pocoo.org/docs/
.. _Werkzeug: http://werkzeug.pocoo.org/
.. _SQLAlchemy: http://www.sqlalchemy.org/
.. include:: contents.rst.inc
c4science · Help