#!/bin/bash # Step 1) (if not done) change the file attribute: # > chmod +x make_doc # Step 2) execute the file: # > ./make_doc echo echo "-- generating Guitastro UML class diagrams (with pyreverse)" echo cd ../src pyreverse -p guitastro -o png guitastro mv classes_guitastro.png ../docs/source/doc_images/generated/ mv packages_guitastro.png ../docs/source/doc_images/generated/ cd ../docs echo echo "-- Generating Guitastro API doc in HTML format (from RST with sphinx)" echo "-- You can open this doc by pointing your browser to doc/doc_rst/build/html/index.html (from guitastro dir)" echo sphinx-build -b html ./source/ ./build/html/ echo echo "-- Generating Guitastro API doc in PDF format (from RST with sphinx)" echo "-- You can open this doc by opening docs/build/pdf/guitastro.pdf (from guitastro dir)" echo sphinx-build -b pdf ./source/ ./build/pdf/