Merge pull request #44 from PyAr/testing

Testing y documentación

Author: WinnaZ

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinxcontrib-napoleon sphinx_rtd_theme
+      - name: Sphinx build
+        run: |
+          sphinx-build -b html docs/source docs/build/html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        # if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/testing' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

README.md

@@ -1,4 +1,8 @@
-# Este es el bot del Pycamp!
+# Este es el bot del Pycamp
+
+## Documentación del módulo
+
+Puede encontrar una documentación mas detallada para programadores en [https://pyar.github.io/PyCamp_Bot](https://pyar.github.io/PyCamp_Bot)
 
 ## Variables de entorno
 
@@ -14,73 +18,62 @@ Esto lo podes hacer hablandole a @BotFather que es el "Bot padre de todos los bo
 Él te a a guiar para que puedas hacer tu propio bot.
 
 Una vez creado el bot, deberías tener un TOKEN\_PERSONAL (BotFather te lo da en el mismo proceso de
-creación). 
+creación).
 
 Despues instala el paquete en modo desarrollo en un virtualenv
 
-```
+~~~bash
 virtualenv -p python3 venv
 source venv/bin/activate
 pip install -e .
-```
+~~~
 
 y estas listo para trabajar.
 
 ## Testeo
 
 Para correr el bot ejecutá (desde el virtualenv):
-```
+
+~~~bash
 TOKEN='TOKEN_PERSONAL' PYCAMP_BOT_MASTER_KEY='KEY' python bin/run_bot.py
-```
+~~~
 
 Y listo! Tu bot está corriendo en tu máquina, esperando que alguien le escriba por telegram.
 Podés probarlo mandandole un `/start`
 
-
 ## ¿Cómo usar el bot en un nuevo pycamp?
 
 Primero es necesario setear las siguientes variables de entorno:
 
-- `TOKEN`: token del bot que se usará durante el pycamp (gestionar desde telegram con BotFather)
-- `PYCAMP_BOT_MASTER_KEY`: con alguna password secreta que se va a usar para acceder a comandos de superuser
-
+* `TOKEN`: token del bot que se usará durante el pycamp (gestionar desde telegram con BotFather)
+* `PYCAMP_BOT_MASTER_KEY`: con alguna password secreta que se va a usar para acceder a comandos de superuser
 
 Una vez creadas las variables de entorno, correr el bot con el comando `python bin/run_bot.py`
 
 En este momento ya se puede hablar con el bot. ¿Qué le digo?
 
-- `/start` para chequear que esté andando bien
+* `/start` para chequear que esté andando bien
 
 ### Flujo admin
 
-- `/su <password>` para reclamar permisos de admin, reemplazando <password> por la contraseña que hayamos 
+* `/su <password>` para reclamar permisos de admin, reemplazando `<password>` por la contraseña que hayamos
 elegido en la envvar `PYCAMP_BOT_MASTER_KEY`
-
-- `/agregar_pycamp <pycamp_name>` para crear un pycamp en la deb
-
-- `activar_pycamp <pycamp_name>` activa un pycamp
-
-- `/empezar_pycamp` setea la fecha de inicio del pycamp activo
-
-- `/empezar_carga_proyectos` habilita la carga de los proyectos. En este punto los pycampistas pueden cargar sus proyectos,
-enviandole al bot el comando `/cargar_proyecto` 
-
-- `/terminar_carga_proyectos` termina carga proyectos
-
-- `/empezar_votacion`  activa la votacion (a partir de ahora los pycampistas pueden votar con `/votar`)
-
-- `/terminar_votacion` termina la votacion
+* `/agregar_pycamp <pycamp_name>` para crear un pycamp en la deb
+* `activar_pycamp <pycamp_name>` activa un pycamp
+* `/empezar_pycamp` setea la fecha de inicio del pycamp activo
+* `/empezar_carga_proyectos` habilita la carga de los proyectos. En este punto los pycampistas pueden cargar sus proyectos,
+enviandole al bot el comando `/cargar_proyecto`
+* `/terminar_carga_proyectos` termina carga proyectos
+* `/empezar_votacion`  activa la votacion (a partir de ahora los pycampistas pueden votar con `/votar`)
+* `/terminar_votacion` termina la votacion
 
 Para generar el schedule:
 
-- `/cronogramear` te va a preguntar cuantos dias queres cronogramear y cuantos slots por dia tenes y hacer el cronograma.
-
-- `/cambiar_slot ` toma un nombre de proyecto y un slot; y te cambia ese proyecto a ese slot.
-
+* `/cronogramear` te va a preguntar cuantos dias queres cronogramear y cuantos slots por dia tenes y hacer el cronograma.
+* `/cambiar_slot` toma un nombre de proyecto y un slot; y te cambia ese proyecto a ese slot.
 
 ### Flujo pycampista
-- `/cargar_proyecto` carga un proyecto (si está habilitada la carga)
-
-- `/votar` envia opciones para votar (si está habilitada la votacion)
 
-- `/ver_cronograma` te muestra el cronograma!
+* `/cargar_proyecto` carga un proyecto (si está habilitada la carga)
+* `/votar` envia opciones para votar (si está habilitada la votacion)
+* `/ver_cronograma` te muestra el cronograma!