PYROS-IRAP / pyros

Commit d9d66439817d19db754c2be0b1f83001708f08bc

Authored by Etienne Pallier
1 parent fe9c9b42
Exists in dev

sphinx doc autogeneration v3

Showing 4 changed files with 40 additions and 17 deletions   Show diff stats
Inline Side-by-side
@@ -51,6 +51,8 @@ out.* @@ -51,6 +51,8 @@ out.*
51 OLD/* 51 OLD/*
52 *_OLD* 52 *_OLD*
53 *_ORIG* 53 *_ORIG*
  54 +*.ORIG
  55 +TMP/*
54 56
55 client.log 57 client.log
56 58
doc/doc_rst/make_rst_then_html
  Diff comments   View file @d9d6643
@@ -25,7 +25,8 @@ pwd @@ -25,7 +25,8 @@ pwd
25 ######sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller 25 ######sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller
26 26
27 # 3) pyros_django package 27 # 3) pyros_django package
28 -####sphinx-apidoc -f -o source -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django 28 +sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
  29 +##sphinx-apidoc -f -o source -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
29 #sphinx-apidoc -f -o source --tocfile pyros_django_package ../../src/core/pyros_django 30 #sphinx-apidoc -f -o source --tocfile pyros_django_package ../../src/core/pyros_django
30 31
31 # 4) Code style package 32 # 4) Code style package
doc/doc_rst/source/conf.py
  Diff comments   View file @d9d6643
@@ -50,6 +50,8 @@ release = '0.4.1' @@ -50,6 +50,8 @@ release = '0.4.1'
50 extensions = [ 50 extensions = [
51 'sphinx.ext.autodoc', # automatically generate documentation for modules 51 'sphinx.ext.autodoc', # automatically generate documentation for modules
52 52
  53 + #'sphinx.ext.autosectionlabel', # automatic link to chapters
  54 +
53 # (EP) sphinx-autodoc-typehints 55 # (EP) sphinx-autodoc-typehints
54 # https://pypi.org/project/sphinx-autodoc-typehints 56 # https://pypi.org/project/sphinx-autodoc-typehints
55 # TODO: pip install sphinx-autodoc-typehints 57 # TODO: pip install sphinx-autodoc-typehints
doc/doc_rst/source/index.rst
  Diff comments   View file @d9d6643
1 -*****************************************************  
2 Welcome in the PyROS developer documentation 1 Welcome in the PyROS developer documentation
3 -***************************************************** 2 +============================================
  3 +
  4 +.. |br| raw:: html
  5 +
  6 + <br />
  7 +
4 8
5 .. image:: ./doc_images/logo-irap-couleur-1024x386.png 9 .. image:: ./doc_images/logo-irap-couleur-1024x386.png
6 :height: 100px 10 :height: 100px
7 :align: center 11 :align: center
8 12
  13 +|br|
  14 +|br|
  15 +
9 +------------------------------+------------------------------------------------------------------+ 16 +------------------------------+------------------------------------------------------------------+
10 | | IRAP | | Project Scientist (PI) : Alain Klotz - aklotz AT irap.omp.eu | 17 | | IRAP | | Project Scientist (PI) : Alain Klotz - aklotz AT irap.omp.eu |
11 | | 9 Avenue Colonel Roche | | Project Manager : Etienne Pallier - epallier AT irap.omp.eu | 18 | | 9 Avenue Colonel Roche | | Project Manager : Etienne Pallier - epallier AT irap.omp.eu |
@@ -13,14 +20,14 @@ Welcome in the PyROS developer documentation @@ -13,14 +20,14 @@ Welcome in the PyROS developer documentation
13 | | FRANCE | | http://pyros.irap.omp.eu | 20 | | FRANCE | | http://pyros.irap.omp.eu |
14 +------------------------------+------------------------------------------------------------------+ 21 +------------------------------+------------------------------------------------------------------+
15 22
16 -.. warning:: This is a warning message, if needed  
17 -  
18 - 23 +.. warning:: This project is under active development.
19 24
  25 +.. note::
  26 + This project is under active development.
20 27
21 28
22 1. PyROS files 29 1. PyROS files
23 -************** 30 +--------------
24 31
25 See in the `Installation documentation - Project structure <https://docs.google.com/document/d/1DjT_rAzeVPl9SnQG3_20GFbDf67JEUAsOD1uhDMlOVw/edit#heading=h.19nwnkgoi5k>`_ 32 See in the `Installation documentation - Project structure <https://docs.google.com/document/d/1DjT_rAzeVPl9SnQG3_20GFbDf67JEUAsOD1uhDMlOVw/edit#heading=h.19nwnkgoi5k>`_
26 33
@@ -30,45 +37,54 @@ See in the `Installation documentation - Project structure &lt;https://docs.google. @@ -30,45 +37,54 @@ See in the `Installation documentation - Project structure &lt;https://docs.google.
30 37
31 using_mount_classes 38 using_mount_classes
32 39
33 -2. PyROS configuration  
34 -********************** 40 +
  41 +2. PyROS general configuration
  42 +------------------------------
35 43
36 See in the `Execution & Configuration documentation - General Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.q3s2zb7c303n>`_ 44 See in the `Execution & Configuration documentation - General Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.q3s2zb7c303n>`_
37 45
38 46
39 47
40 -1. Observatory configuration  
41 -**************************** 48 +3. Observatory configuration
  49 +----------------------------
42 50
43 See in the `Execution & Configuration documentation - Observatory Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.ec6uvlb3rto4>`_ 51 See in the `Execution & Configuration documentation - Observatory Configuration <https://docs.google.com/document/d/1Nj80hsvE9LQll4KehBpfXLC1QQMjUKoXb4U_VmNHnDI/edit#heading=h.ec6uvlb3rto4>`_
44 52
45 53
46 54
47 -1. PyROS API Source Code documentation  
48 -************************************** 55 +4. PyROS API Source Code documentation
  56 +--------------------------------------
49 57
50 -(TODO) The PyROS Packages, Classes, and Methods 58 +The PyROS :doc:`Packages, Classes, and Methods<generated_api/pyros_django_package>`
51 59
52 60
53 61
54 -5. Guitastro doc  
55 -**************** 62 +5. Guitastro package documentation
  63 +----------------------------------
56 64
57 See in the `Guitastro documentation <../../../../vendor/guitastro/doc_rst/build/html/index.html>`_ 65 See in the `Guitastro documentation <../../../../vendor/guitastro/doc_rst/build/html/index.html>`_
58 66
59 67
  68 +6. PyROS Python source code style recommandations
  69 +-------------------------------------------------
  70 +
  71 +:doc:`generated_api/codestyle_examples_package`
  72 +
60 73
61 74
  75 +=====================================================================================
  76 +
62 77
63 78
64 .. COMMENT: The toctree directive is mainly to let Sphinx be aware of the document hierarchy (the sidebar will reflect this understanding) 79 .. COMMENT: The toctree directive is mainly to let Sphinx be aware of the document hierarchy (the sidebar will reflect this understanding)
65 80
66 81
67 .. toctree:: 82 .. toctree::
68 - :maxdepth: 3 83 + :maxdepth: 1
69 :caption: Contents: 84 :caption: Contents:
70 85
71 generated_api/codestyle_examples_package 86 generated_api/codestyle_examples_package
  87 + generated_api/pyros_django_package
72 88
73 .. comment guitastro 89 .. comment guitastro
74 90
@@ -86,6 +102,8 @@ See in the `Guitastro documentation &lt;../../../../vendor/guitastro/doc_rst/build/ @@ -86,6 +102,8 @@ See in the `Guitastro documentation &lt;../../../../vendor/guitastro/doc_rst/build/
86 .. pyros-doc-DEV 102 .. pyros-doc-DEV
87 .. modules 103 .. modules
88 104
  105 +=====================================================================================
  106 +
89 107
90 Indices and tables 108 Indices and tables
91 ================== 109 ==================