doc/Makefile

   1 WEBDIR  = /www/manuals
   2
   3 all: html pdf
   4
   5 pdf: check-latex
   6         @echo "Building PDF documentation"
   7         sphinx-build -b latex -n . pdf
   8         make -C pdf
   9         @echo "PDF documentation built. Open ./pdf/charm.pdf in a PDF viewer."
  10
  11 html: check-sphinx
  12         @echo "Building HTML documentation"
  13         sphinx-build -n . html
  14         @echo "HTML documentation built. Open ./html/index.html in a web browser."
  15
  16 # This rule was used to copy the manual to our local web server
  17 # web: all
  18 #       -rm -rf $(WEBDIR)/backup
  19 #       mkdir -p $(WEBDIR)/backup && \
  20 #       mv $(WEBDIR)/pdf $(WEBDIR)/html $(WEBDIR)/backup
  21 #       cp -r pdf html $(WEBDIR) && \
  22 #       chgrp -R kale $(WEBDIR)/pdf $(WEBDIR)/html && \
  23 #       chmod -R g+w  $(WEBDIR)/pdf $(WEBDIR)/html || \
  24 #       { rm -rf $(WEBDIR)/pdf $(WEBDIR)/html && \
  25 #       mv $(WEBDIR)/backup/pdf $(WEBDIR)/backup/html $(WEBDIR); }
  26 #       -rm -rf $(WEBDIR)/backup
  27
  28 clean:
  29         rm -rf pdf html
  30
  31 check-sphinx:
  32         @which -s sphinx-build || { echo "Sphinx (http://www.sphinx-doc.org) not found. Install it with 'pip install sphinx'."; exit 1; }
  33
  34 check-latex: check-sphinx
  35         @which -s pdflatex || { echo "Warning: Pdflatex not found. Exiting."; exit 1; }