PYROS-IRAP / pyros

Commit 89e6dc93079f415e705805606580d6711ed09f9b

Authored by Etienne Pallier
1 parent 46b2415a
Exists in dev

reactivated guitastro sphinx doc

Showing 1 changed file with 45 additions and 8 deletions   Show diff stats
Inline Side-by-side
doc/doc_rst/make_rst_then_html
  Diff comments   View file @89e6dc9
1 1  
  2 +echo
  3 +echo "*****************************"
  4 +echo "* GENERATING SPHINX API DOC *"
  5 +echo "*****************************"
  6 +echo
  7 +
2 8 # A - Generate RST files
3 9 # ---------------------------------
4 10  
... ... @@ -7,16 +13,19 @@
7 13  
8 14 #sphinx-apidoc -f -o source ../../src/core
9 15  
10   -# 1) guitastro package (celme)
  16 +# 1) GuitAstro package (ex celme)
  17 +ON=true
11 18 echo
12 19 echo "- Guitastro : generating UML class diagrams and API doc"
  20 +echo " -----------------------------------------------------"
13 21 echo
14 22 # Doc au format de Alain
15 23 cd ../../vendor/guitastro/doc/doc_rst/
16 24 pwd
17   -./make_doc
  25 +$ON && ./make_doc
18 26 #make html
19 27 #./MAKE_DOC.sh
  28 +
20 29 # Doc au format de Etienne (just uncomment 1st line)
21 30 ###sphinx-apidoc -f -o source/generated_api -a --separate --tocfile guitastro_package ../../vendor/guitastro
22 31 ###sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile guitastro_package ../../vendor/guitastro
... ... @@ -27,16 +36,30 @@ cd -
27 36 pwd
28 37  
29 38 # 2) device_controller package
30   -######sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller
  39 +ON=false
  40 +echo
  41 +echo "- PyROS DeviceController : generating API doc RST files (Sphinx)"
  42 +echo " --------------------------------------------------------------"
  43 +echo
  44 +$ON && sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile device_controller_package ../../src/device_controller
  45 +#sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller
  46 +
31 47  
32 48 # 3) pyros_django package
33   -######sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
  49 +ON=false
  50 +echo
  51 +echo "- PyROS django core : generating API doc RST files (Sphinx)"
  52 +echo " --------------------------------------------------------------"
  53 +echo
  54 +$ON && sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
34 55 ##sphinx-apidoc -f -o source -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django
35 56 #sphinx-apidoc -f -o source --tocfile pyros_django_package ../../src/core/pyros_django
36 57  
37 58 # 4) Code style package
  59 +ON=true
38 60 echo
39   -echo "- Codestyle : generating UML class diagrams and API doc"
  61 +echo "- Codestyle : generating UML class diagrams and API doc RST files"
  62 +echo " ---------------------------------------------------------------"
40 63 echo
41 64 echo "-- generating UML class diagrams in source/doc_images/generated/ (pyreverse)"
42 65 echo
... ... @@ -55,15 +78,29 @@ sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile
55 78 #sphinx-apidoc -f -o --implicit-namespaces source ../../src/
56 79  
57 80  
58   -# B - Generate HTML and PDF files (from RST)
  81 +
  82 +##exit
  83 +
  84 +
  85 +
  86 +
  87 +# B - Generate PyROS HTML and PDF files (from RST)
59 88 # -------------------------------------------
60 89  
61 90 echo
62   -echo "-- generating API doc HTML files in build/html/index.html (from RST, with Sphinx)"
  91 +echo "- Generating PyROS API doc HTML files in build/html/index.html (from RST, with Sphinx)"
  92 +echo " ------------------------------------------------------------------------------------"
63 93 echo
64 94 sphinx-build -b html ./source/ build/html/
65 95  
66 96 echo
67   -echo "-- generating API doc PDF file in build/pdf/Python.pdf (from RST, with Sphinx)"
  97 +echo "- Generating PyROS API doc PDF file in build/pdf/Python.pdf (from RST, with Sphinx)"
  98 +echo " ------------------------------------------------------------------------------------"
68 99 echo
69 100 sphinx-build -b pdf source build/pdf/
  101 +
  102 +echo
  103 +echo "**************************************************************************************************************************************"
  104 +echo "NOW, YOU CAN VIEW THE API DOCUMENTATION BY POINTING YOUR LOCAL BROWSER TO : doc/doc_rst/build/html/index.html (from PyROS root folder)"
  105 +echo "**************************************************************************************************************************************"
  106 +echo
... ...