Move docs to Sphinx

[cuducos]

What is the purpose of this Pull Request?

README.md was too long and a lot of information might be difficult to find that way.

What was done to achieve this purpose?

To start to better organize docs about Jarbas using Sphinx.

How to test if it really works?

Edit docker-compose.yml to build containers locally:

diff --git a/docker-compose.yml b/docker-compose.yml
index 6f11126..e2f6d72 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -2,7 +2,9 @@ version: '3'
 services:

   django:
-    image: datasciencebr/jarbas-backend
+    # image: datasciencebr/jarbas-backend
+    build:
+      context: .
     environment:
       - ALLOWED_HOSTS=localhost,127.0.0.1
       - AMAZON_S3_BUCKET=serenata-de-amor-data
@@ -17,7 +19,9 @@ services:
       - "./contrib/data:/mnt/data"

   tasks:
-    image: datasciencebr/jarbas-backend
+    # image: datasciencebr/jarbas-backend
+    build:
+      context: .
     environment:
       - CELERY_BROKER_URL=amqp://guest:guest@queue/
       - NEW_RELIC_APP_NAME=Jarbas (Celery); Jarbas (Combined)

Build containers with docker-compose -f docker-compose.yml -f docker-compose.override.yml build.

Access one of the containers and build the docs:

docker-compose -f docker-compose.yml -f docker-compose.override.yml run --rm tasks /bin/sh
cd docs
make html

Access docs/build/html/index.html in the browser.

Who can help reviewing it? @jtemporal @Irio @anaschwendler

TODO

• [ ] Update account as in #323
• [ ] Break install.rst and api.rst in smaller files (for example, api_chamber_of_deputies.rst, api_general.rst, settings.rst, local.rst, docker.rst etc.)
• [ ] Publish the documentation on Read the Docs and link it in README.md

[cuducos]

Closed – gonna get back after merging jarbas into serenata-de-amor repo ; )