diff --git a/doc/doc_rst/make_rst_then_html b/doc/doc_rst/make_rst_then_html index 6d55a2e..6bebb9a 100755 --- a/doc/doc_rst/make_rst_then_html +++ b/doc/doc_rst/make_rst_then_html @@ -1,4 +1,10 @@ +echo +echo "*****************************" +echo "* GENERATING SPHINX API DOC *" +echo "*****************************" +echo + # A - Generate RST files # --------------------------------- @@ -7,16 +13,19 @@ #sphinx-apidoc -f -o source ../../src/core -# 1) guitastro package (celme) +# 1) GuitAstro package (ex celme) +ON=true echo echo "- Guitastro : generating UML class diagrams and API doc" +echo " -----------------------------------------------------" echo # Doc au format de Alain cd ../../vendor/guitastro/doc/doc_rst/ pwd -./make_doc +$ON && ./make_doc #make html #./MAKE_DOC.sh + # Doc au format de Etienne (just uncomment 1st line) ###sphinx-apidoc -f -o source/generated_api -a --separate --tocfile guitastro_package ../../vendor/guitastro ###sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile guitastro_package ../../vendor/guitastro @@ -27,16 +36,30 @@ cd - pwd # 2) device_controller package -######sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller +ON=false +echo +echo "- PyROS DeviceController : generating API doc RST files (Sphinx)" +echo " --------------------------------------------------------------" +echo +$ON && sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile device_controller_package ../../src/device_controller +#sphinx-apidoc -o source -a --separate --module-first --tocfile device_controller_package ../../src/device_controller + # 3) pyros_django package -######sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile pyros_django_package ../../src/core/pyros_django +ON=false +echo +echo "- PyROS django core : generating API doc RST files (Sphinx)" +echo " --------------------------------------------------------------" +echo +$ON && 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 +ON=true echo -echo "- Codestyle : generating UML class diagrams and API doc" +echo "- Codestyle : generating UML class diagrams and API doc RST files" +echo " ---------------------------------------------------------------" echo echo "-- generating UML class diagrams in source/doc_images/generated/ (pyreverse)" echo @@ -55,15 +78,29 @@ sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile #sphinx-apidoc -f -o --implicit-namespaces source ../../src/ -# B - Generate HTML and PDF files (from RST) + +##exit + + + + +# B - Generate PyROS HTML and PDF files (from RST) # ------------------------------------------- echo -echo "-- generating API doc HTML files in build/html/index.html (from RST, with Sphinx)" +echo "- Generating PyROS API doc HTML files in build/html/index.html (from RST, with Sphinx)" +echo " ------------------------------------------------------------------------------------" echo sphinx-build -b html ./source/ build/html/ echo -echo "-- generating API doc PDF file in build/pdf/Python.pdf (from RST, with Sphinx)" +echo "- Generating PyROS API doc PDF file in build/pdf/Python.pdf (from RST, with Sphinx)" +echo " ------------------------------------------------------------------------------------" echo sphinx-build -b pdf source build/pdf/ + +echo +echo "**************************************************************************************************************************************" +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)" +echo "**************************************************************************************************************************************" +echo -- libgit2 0.21.2