Generate usage examples for FleurXMLModifier in docs

.gitignore

@@ -92,6 +92,7 @@ instance/
 # Sphinx documentation
 docs/_build/
 docs/source/_build/
+docs/source/user_guide/fleurxmlmodifier_usage_examples/examples
 
 # PyBuilder
 target/

.pre-commit-config.yaml

@@ -96,6 +96,7 @@ repos:
             masci_tools/io/fleurxmlmodifier.py|
             masci_tools/io/common_functions.py|
             masci_tools/util/xml/.*py|
+            masci_tools/util/sphinxext/.*py|
             masci_tools/util/lockable_containers.py|
             masci_tools/util/case_insensitive_dict.py|
             masci_tools/util/schema_dict_util.py|

docs/Makefile

@@ -6,6 +6,7 @@
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
+PYTHON3      ?= python3
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -14,7 +15,7 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: help clean modifier-docstrings html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
@@ -41,7 +42,10 @@ help:
 clean:
 	-rm -r $(BUILDDIR)
 
-html:
+modifier-docstrings:
+	$(PYTHON3) ../utils/write_fleurxmlmodifier_docstrings.py
+
+html: modifier-docstrings
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."