Merge pull request #357 from oparry-ukaea/docs-build-improvements

Some changes to simplify building the docs locally.

Author: oparry-ukaea

.gitignore

@@ -7,11 +7,15 @@ BOUT.settings
 *~
 .DS_Store
 /build*
-/docs/build/*
-/docs/doxygen/*
-/docs/sphinx/_breathe*
 __pycache__
 
+# Docs
+/docs/build
+/docs/doxygen
+/docs/html
+/docs/hermes3.pdf
+/docs/sphinx/_breathe*
+
 # IDE config files
 .vscode
 

docs/makefile

@@ -9,7 +9,9 @@ manual: all
 pdf: sphinx-pdf
 html: sphinx-html
 man: sphinx-man
-sphinx: sphinx-pdf
+sphinx: sphinx-html
+
+.PHONY: breathe-autogen, doxygen-build, clean, html, man, manual, pdf, sphinx, sphinx-html, sphinx-man, sphinx-pdf
 
 sphinx-pdf: doxygen
 	$(sphinx-build) -b latex sphinx/ build/

docs/sphinx/examples.rst

@@ -52,7 +52,7 @@ other. Ions recycle into neutrals, which charge exchange and are
 ionised.  A difference is that separate ion and electron temperatures
 are evolved here.
 
-.. figure:: figs/1d_threshold.gif
+.. figure:: figs/1d_threshold.*
    :name: 1d_threshold_fig
    :alt:
    :width: 60%