Blame view

docs/make_doc 866 Bytes
96482ab2   Alain Klotz   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#!/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/