Commit 7957f9e57a69fbd0477e204b72cf19d99ee2fb23
1 parent
300eeb29
Exists in
master
Some updates in the doc.
Showing
2 changed files
with
9 additions
and
9 deletions
Show diff stats
docs/make_doc
| @@ -6,24 +6,24 @@ | @@ -6,24 +6,24 @@ | ||
| 6 | # > ./make_doc | 6 | # > ./make_doc |
| 7 | 7 | ||
| 8 | echo | 8 | echo |
| 9 | -echo "-- generating guitastro_device_deltatau UML class diagrams (with pyreverse)" | 9 | +echo "-- generating guitastro_device_flipro UML class diagrams (with pyreverse)" |
| 10 | echo | 10 | echo |
| 11 | cd ../src | 11 | cd ../src |
| 12 | -pyreverse -p guitastro_device_deltatau -o png guitastro_device_deltatau | ||
| 13 | -mv classes_guitastro_device_deltatau.png ../docs/source/doc_images/generated/ | ||
| 14 | -mv packages_guitastro_device_deltatau.png ../docs/source/doc_images/generated/ | 12 | +pyreverse -p guitastro_device_flipro -o png guitastro_device_flipro |
| 13 | +mv classes_guitastro_device_flipro.png ../docs/source/doc_images/generated/ | ||
| 14 | +mv packages_guitastro_device_flipro.png ../docs/source/doc_images/generated/ | ||
| 15 | 15 | ||
| 16 | cd ../docs | 16 | cd ../docs |
| 17 | 17 | ||
| 18 | echo | 18 | echo |
| 19 | -echo "-- Generating guitastro_device_deltatau API doc in HTML format (from RST with sphinx)" | ||
| 20 | -echo "-- You can open this doc by pointing your browser to docs/build/html/index.html (from guitastro_device_deltatau dir)" | 19 | +echo "-- Generating guitastro_device_flipro API doc in HTML format (from RST with sphinx)" |
| 20 | +echo "-- You can open this doc by pointing your browser to docs/build/html/index.html (from guitastro_device_flipro dir)" | ||
| 21 | echo | 21 | echo |
| 22 | sphinx-build -b html ./source/ ./build/html/ | 22 | sphinx-build -b html ./source/ ./build/html/ |
| 23 | 23 | ||
| 24 | echo | 24 | echo |
| 25 | -echo "-- Generating guitastro_device_deltatau API doc in PDF format (from RST with sphinx)" | ||
| 26 | -echo "-- You can open this doc by opening docs/build/pdf/guitastro_device_deltatau.pdf (from guitastro_device_deltatau dir)" | 25 | +echo "-- Generating guitastro_device_flipro API doc in PDF format (from RST with sphinx)" |
| 26 | +echo "-- You can open this doc by opening docs/build/pdf/guitastro_device_flipro.pdf (from guitastro_device_flipro dir)" | ||
| 27 | echo | 27 | echo |
| 28 | sphinx-build -b pdf ./source/ ./build/pdf/ | 28 | sphinx-build -b pdf ./source/ ./build/pdf/ |
| 29 | 29 |
docs/make_doc.bat
| @@ -2,7 +2,7 @@ | @@ -2,7 +2,7 @@ | ||
| 2 | 2 | ||
| 3 | echo This batch must be launched with PowerShell in administrator mode. | 3 | echo This batch must be launched with PowerShell in administrator mode. |
| 4 | call :ResolvePath path_guitastro %cd%\.. | 4 | call :ResolvePath path_guitastro %cd%\.. |
| 5 | -echo Guitastro Device FLIPRO in the directory %path_guitastro% | 5 | +echo Guitastro Device Flipro in the directory %path_guitastro% |
| 6 | 6 | ||
| 7 | rem Search where is Anaconda | 7 | rem Search where is Anaconda |
| 8 | set path_anacondas=c:\Users\%USERNAME%\Anaconda3 C:\ProgramData\Anaconda3 | 8 | set path_anacondas=c:\Users\%USERNAME%\Anaconda3 C:\ProgramData\Anaconda3 |