From d9d66439817d19db754c2be0b1f83001708f08bc Mon Sep 17 00:00:00 2001
From: Etienne Pallier <epallier@irap.omp.eu>
Date: Mon, 7 Mar 2022 13:24:35 +0100
Subject: [PATCH] sphinx doc autogeneration v3

---
 .gitignore                     |  2 ++
 doc/doc_rst/make_rst_then_html |  3 ++-
 doc/doc_rst/source/conf.py     |  2 ++
 doc/doc_rst/source/index.rst   | 50 ++++++++++++++++++++++++++++++++++----------------
 4 files changed, 40 insertions(+), 17 deletions(-)

diff --git a/.gitignore b/.gitignore
index 132ee3c..b6e9586 100644
--- a/.gitignore
+++ b/.gitignore
@@ -51,6 +51,8 @@ out.*
 OLD/*
 *_OLD*
 *_ORIG*
+*.ORIG
+TMP/*
 
 client.log
 
diff --git a/doc/doc_rst/make_rst_then_html b/doc/doc_rst/make_rst_then_html
index 55d2d83..2f3170c 100755
--- a/doc/doc_rst/make_rst_then_html
+++ b/doc/doc_rst/make_rst_then_html
@@ -25,7 +25,8 @@ pwd
 ######sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller
 
 # 3) pyros_django package
-####sphinx-apidoc -f -o source -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
+sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
+##sphinx-apidoc -f -o source -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
 #sphinx-apidoc -f -o source --tocfile pyros_django_package ../../src/core/pyros_django
 
 # 4) Code style package
diff --git a/doc/doc_rst/source/conf.py b/doc/doc_rst/source/conf.py
index ccc653d..a191acf 100644
--- a/doc/doc_rst/source/conf.py
+++ b/doc/doc_rst/source/conf.py
@@ -50,6 +50,8 @@ release = '0.4.1'
 extensions = [
     'sphinx.ext.autodoc',  # automatically generate documentation for modules
 
+    #'sphinx.ext.autosectionlabel',  # automatic link to chapters
+
     # (EP) sphinx-autodoc-typehints
     # https://pypi.org/project/sphinx-autodoc-typehints
     # TODO: pip install sphinx-autodoc-typehints
diff --git a/doc/doc_rst/source/index.rst b/doc/doc_rst/source/index.rst
index 2c6d5e7..31de331 100644
--- a/doc/doc_rst/source/index.rst
+++ b/doc/doc_rst/source/index.rst
@@ -1,11 +1,18 @@
-*****************************************************
 Welcome in the PyROS developer documentation
-*****************************************************
+============================================
+
+.. |br| raw:: html
+
+   <br />
+
 
 .. image:: ./doc_images/logo-irap-couleur-1024x386.png
 	:height: 100px
 	:align: center
 
+|br|
+|br|
+
 +------------------------------+------------------------------------------------------------------+
 | | IRAP                       | | Project Scientist (PI) : Alain Klotz - aklotz AT irap.omp.eu   |
 | | 9 Avenue Colonel Roche     | | Project Manager : Etienne Pallier - epallier AT irap.omp.eu    |
@@ -13,14 +20,14 @@ Welcome in the PyROS developer documentation
 | | FRANCE                     | | http://pyros.irap.omp.eu                                       |
 +------------------------------+------------------------------------------------------------------+
 
-.. warning:: This is a warning message, if needed
-
-
+.. warning:: This project is under active development.
 
+.. note::
+   This project is under active development.
 
 
 1. PyROS files
-**************
+--------------
 
 See in the `Installation documentation - Project structure <https://docs.google.com/document/d/1DjT_rAzeVPl9SnQG3_20GFbDf67JEUAsOD1uhDMlOVw/edit#heading=h.19nwnkgoi5k>`_
 
@@ -30,45 +37,54 @@ See in the `Installation documentation - Project structure <https://docs.google.
         
        using_mount_classes
 
-2. PyROS configuration
-**********************
+
+2. PyROS general configuration
+------------------------------
 
 See in the `Execution & Configuration documentation - General Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.q3s2zb7c303n>`_
 
 
 
-1. Observatory configuration
-****************************
+3. Observatory configuration
+----------------------------
 
 See in the `Execution & Configuration documentation - Observatory Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.ec6uvlb3rto4>`_
 
 
 
-1. PyROS API Source Code documentation
-**************************************
+4. PyROS API Source Code documentation
+--------------------------------------
 
-(TODO) The PyROS Packages, Classes, and Methods
+The PyROS :doc:`Packages, Classes, and Methods<generated_api/pyros_django_package>`
 
 
 
-5. Guitastro doc
-****************
+5. Guitastro package documentation
+----------------------------------
 
 See in the `Guitastro documentation <../../../../vendor/guitastro/doc_rst/build/html/index.html>`_
 
 
+6. PyROS Python source code style recommandations
+-------------------------------------------------
+
+:doc:`generated_api/codestyle_examples_package`
+
 
 
+=====================================================================================
+
 
 
 .. COMMENT: The toctree directive is mainly to let Sphinx be aware of the document hierarchy (the sidebar will reflect this understanding)
 
 
 .. toctree:: 
-    :maxdepth: 3
+    :maxdepth: 1
     :caption: Contents:
 
     generated_api/codestyle_examples_package
+    generated_api/pyros_django_package
 
 .. comment    guitastro
 
@@ -86,6 +102,8 @@ See in the `Guitastro documentation <../../../../vendor/guitastro/doc_rst/build/
 ..   pyros-doc-DEV
 ..   modules
 
+=====================================================================================
+
 
 Indices and tables
 ==================
--
libgit2 0.21.2