.. _index:

=======================
Booktype developer docs
=======================

Welcome! This is the documentation for contributors to the Booktype project.

.. toctree::
    :hidden:

    deployment/index
    development/index


Deployment
==========

For installation and usage instructions, please read the manual `Booktype for Authors and Publishers`_.

* **Project:** 
  :doc:`Structure <deployment/structure>` |
  :doc:`Profiles <deployment/profiles>`

* **Settings:**
  :doc:`Booktype <deployment/booktype_settings>` |
  :doc:`PostgreSQL <deployment/postgresql>` |
  :doc:`Redis <deployment/redis_settings>` |
  Supervisor |
  RabbitMQ 

* **Publishing:**
  :doc:`MOBI <deployment/mobi>`

* **Scripts:**
  :doc:`Createbooktype <deployment/createbooktype>` |
  Backup  

* **Upgrades:**
  :doc:`Instructions <deployment/upgrade_instruction>`

* **Unoffical platforms:**
  :doc:`CentOS <deployment/centos>` |
  :doc:`Mac OS X <deployment/macosx>` |
  :doc:`Nginx <deployment/nginx>`

Development
===========

Learn about the development and testing of Booktype:

* **Contributing:** 
  :doc:`How to contribute <development/contribute>` |
  :doc:`Before you send a pull request <development/pull>`

* **Setup:** 
  :doc:`Development profile <development/profile>`

* **Code:**
  :doc:`Python style <development/style>` |
  :doc:`JavaScript style <development/js_style>` |
  :doc:`Testing <development/testing>` |
  :doc:`Documenting <development/documenting>`

Community
=========

* **Forum:** 
  `Support forum`_ |
  `Development forum`_ |
  `Documentation forum`_

* **Resources:**
  `GitHub`_ |
  `Tracker`_ |
  `Translation platform`_

.. _Support forum: http://forum.sourcefabric.org/categories/booktype-support
.. _Development forum: http://forum.sourcefabric.org/categories/booktype-development
.. _Documentation forum: http://forum.sourcefabric.org/categories/booktype-documentation
.. _Booktype for Authors and Publishers: https://sourcefabric.booktype.pro/booktype-24-for-authors-and-publishers/
.. _GitHub: https://github.com/booktype/Booktype
.. _Tracker: https://dev.sourcefabric.org/browse/BK
.. _Translation platform: https://transifex.com/sourcefabric/booktype

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`