Sphinx autodoc generation (v9) + pyreverse + pdf & Dockerfile install guitastro + bash aliases

Etienne Pallier
1 parent 83cfb55c
Showing 5 changed files with 32 additions and 11 deletions Show diff stats
.bash_aliases
Dockerfile
doc/doc_rst/.gitignore
doc/doc_rst/make_rst_then_html
doc/doc_rst/source/conf.py
@@ -0,0 +1,3 @@
+alias l="ls -lF"
+alias la="ls -alF"
+alias cdb="cd .. ; l"
@@ -74,14 +74,14 @@ RUN rm ./astap_amd64.deb
 RUN echo | openssl s_client -connect gitlab.irap.omp.eu:443 -servername gitlab.irap.omp.eu 2>/dev/null | openssl x509 > /etc/ssl/certs/gitlab.irap.omp.eu.crt
 RUN echo "$uid" > test.txt
-# adding new user (pyros_user) and creating his home folder
+# Adding new user (pyros_user) and creating his home folder
 RUN useradd --create-home --shell /bin/bash pyros_user --uid $uid
 # Create the work dir and set permissions as pyros_user 
 RUN mkdir -p /home/pyros_user/app/ && chown -R pyros_user:pyros_user /home/pyros_user/app
 WORKDIR /home/pyros_user/app
-# switch from root to pyros_user
+# Switch from root to pyros_user
 USER pyros_user
 RUN pip install --user --upgrade pip
@@ -89,15 +89,19 @@ RUN pip install --user wheel
 # TODO: pourquoi numpy ??? A virer ?
 RUN pip install --user numpy
-# copy local host machine files to image
+# Copy local host machine files to image
 COPY --chown=pyros_user:pyros_user . .
+# Copy some aliases
+RUN cp .bash_aliases ..
+#RUN mv .bash_aliases ..
+#COPY --chown=pyros_user:pyros_user .bash_aliases ..
-# adding local/bin to path to avoid pip warning
+# Adding local/bin to path to avoid pip warning
 ENV PATH "$PATH:/home/pyros_user/.local/bin"
-# installing click on the image to prevent error on the first execution of the installation script
+# Installing click on the image to prevent error on the first execution of the installation script
 RUN pip install --user click
-# installing packages required for PyROS
+# Installing packages required for PyROS
 RUN pip install --user -r ./install/requirements.txt
 RUN pip install --user -r ./install/requirements_dev.txt
 build*/*
 TMP
-source/generated_api/*
+source/generated_api
@@ -38,12 +38,15 @@ pwd
 echo
 echo "- Codestyle : generating UML class diagrams and API doc"
 echo
-echo "-- generating UML class diagrams (pyreverse)"
+echo "-- generating UML class diagrams in source/doc_images/generated/ (pyreverse)"
+echo
 cd ../codestyle_examples/
 pyreverse -p codestyle_examples -o png codestyle_examples
 cd -
 mv ../codestyle_examples/*.png source/doc_images/generated/
+echo
 echo "-- generating API doc RST files (Sphinx)"
+echo
 sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile codestyle_examples_package ../codestyle_examples
 ##sphinx-apidoc -f -o source -a --separate --module-first --tocfile codestyle_examples_package ../codestyle_examples
 #sphinx-apidoc -o source -a --separate --module-first --tocfile code_style_package ../code_style/my_package1
@@ -55,6 +58,12 @@ sphinx-apidoc -f -o source/generated_api -a --separate --module-first --tocfile 
 # B - Generate HTML (and pdf) files (from RST)
 # ---------------------------------
-echo "-- generating API doc HTML files (from RST, with Sphinx)"
-sphinx-build -b html source build/html/
-#sphinx-build -b pdf source build
+echo
+echo "-- generating API doc HTML files in build/html/index.html (from RST, with Sphinx)"
+echo
+sphinx-build -b html ./source/ build/html/
+
+echo
+echo "-- generating API doc HTML files in build/pdf/Python.pdf (from RST, with Sphinx)"
+echo
+sphinx-build -b pdf source build/pdf/
@@ -214,3 +214,8 @@ html_theme = &#39;sphinx_rtd_theme&#39;
 html_static_path = ['_static']
 autosummary_generate = True
+
+# Added to avoid this error :
+# [ERROR] createpdf.py:1134 Template 'twoColumn' is not defined
+# => twoColumn is no longer part of the default styles in rst2pdf 0.99, so you now need to explicitly include the twoColumn style file.
+pdf_stylesheets = ['twocolumn']