tiny documentation improvements (#204)

Author: dham

docs/Makefile

@@ -61,7 +61,7 @@ html:
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 livehtml:
-	sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	sphinx-autobuild --port 8001 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

docs/source/documentation/pyadjoint_api.rst

@@ -64,6 +64,8 @@ Core utility functions
 
 .. autofunction:: get_working_tape
 .. autofunction:: set_working_tape
+.. autofunction:: continue_annotation
+.. autofunction:: pause_annotation
 .. autofunction:: pyadjoint.tape.no_annotations
 .. autoclass:: stop_annotating
 .. autofunction:: annotate_tape

pyadjoint/tape.py

@@ -18,11 +18,13 @@ def get_working_tape():
 
 
 def pause_annotation():
+    """Switch off annotation."""
     global _annotation_enabled
     _annotation_enabled = False
 
 
 def continue_annotation():
+    """Switch on annotation."""
     global _annotation_enabled
     _annotation_enabled = True
     return _annotation_enabled