Generate api stubs as part of doc build

python-periodictable · Oct 7, 2024 · 962de3a · 962de3a
1 parent 66b543a
commit 962de3a
Show file tree

Hide file tree

Showing 18 changed files with 13 additions and 260 deletions.
diff --git a/doc/sphinx/Makefile b/doc/sphinx/Makefile
@@ -7,13 +7,18 @@ SPHINXOPTS    = -W --keep-going -n
 SPHINXBUILD   = $(PYTHON) -m sphinx
 PAPER         =
 BUILDDIR      = _build
+ifdef ComSpec
+    RMDIR   = rmdir /s/q
+else
+    RMDIR   = rm -rf
+endif
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest build
+.PHONY: help api clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest build
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
@@ -29,9 +34,13 @@ help:
 	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
 
 clean:
-	-rm -rf _build/* build/* plots/*.pyc plots/*.png
+	-rm -rf _build/* build/* plots/*.pyc plots/*.png api
 
-html:
+api: genmods.py
+	-$(RMDIR) api
+	"$(PYTHON)" genmods.py
+
+html: api
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
 	@echo
 	@echo "Build finished. The HTML pages are in _build/html."
@@ -91,4 +100,3 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in _build/doctest/output.txt."
-
diff --git a/doc/sphinx/api/activation.rst b/doc/sphinx/api/activation.rst
diff --git a/doc/sphinx/api/constants.rst b/doc/sphinx/api/constants.rst
diff --git a/doc/sphinx/api/core.rst b/doc/sphinx/api/core.rst
diff --git a/doc/sphinx/api/covalent_radius.rst b/doc/sphinx/api/covalent_radius.rst
diff --git a/doc/sphinx/api/cromermann.rst b/doc/sphinx/api/cromermann.rst
diff --git a/doc/sphinx/api/crystal_structure.rst b/doc/sphinx/api/crystal_structure.rst
diff --git a/doc/sphinx/api/density.rst b/doc/sphinx/api/density.rst
diff --git a/doc/sphinx/api/fasta.rst b/doc/sphinx/api/fasta.rst
diff --git a/doc/sphinx/api/formulas.rst b/doc/sphinx/api/formulas.rst
diff --git a/doc/sphinx/api/index.rst b/doc/sphinx/api/index.rst
diff --git a/doc/sphinx/api/magnetic_ff.rst b/doc/sphinx/api/magnetic_ff.rst
diff --git a/doc/sphinx/api/mass.rst b/doc/sphinx/api/mass.rst
diff --git a/doc/sphinx/api/nsf.rst b/doc/sphinx/api/nsf.rst
diff --git a/doc/sphinx/api/plot.rst b/doc/sphinx/api/plot.rst
diff --git a/doc/sphinx/api/util.rst b/doc/sphinx/api/util.rst
diff --git a/doc/sphinx/api/xsf.rst b/doc/sphinx/api/xsf.rst
diff --git a/doc/sphinx/genmods.py b/doc/sphinx/genmods.py
@@ -55,7 +55,6 @@ def genfiles(package, package_name, modules, dir='api'):
     #('__init__', 'Top level namespace'),
     ('core', 'Core table'),
     ('formulas', 'Chemical formula operations'),
-    #('chemicals', 'Chemical database'),
     ('covalent_radius', 'Covalent radius'),
     ('constants', 'Fundamental constants'),
     ('crystal_structure', 'Crystal structure'),
@@ -69,6 +68,7 @@ def genfiles(package, package_name, modules, dir='api'):
     ('cromermann', 'X-ray scattering factor f0 calculations'),
     ('plot', 'Element plotter'),
     ('util', 'Utility functions'),
+    ('mass_2001', 'Deprecated mass/abundance values'),
 ]
 package='periodictable'
 package_name='Reference'