Fix RTD rendering of inheritance diagram; show API docs (#120)

weiwei · Jan 3, 2024 · 2066ebd · 2066ebd
1 parent a1c3ebd
commit 2066ebd
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -52,7 +52,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/api
+docs/api_generated/
 
 # PyBuilder
 target/

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,6 +7,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  apt_packages:
+    - graphviz
 
 python:
   install:

diff --git a/docs/Makefile b/docs/Makefile
@@ -17,5 +17,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXAPIDOC) -f -o api/ -H "API" -e ../junitparser
+	@$(SPHINXAPIDOC) -f -o api_generated/ -H "API" -e ../junitparser
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/api/inheritance_diagram.rst b/docs/api/inheritance_diagram.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "junitparser"
-copyright = "2019-2023, Joel Wang"
+copyright = "2019-2024, Joel Wang"
 author = "Joel Wang"
 
 # The short X.Y version
@@ -184,3 +184,7 @@
 
 
 # -- Extension configuration -------------------------------------------------
+
+# -- Extra setup for inheritance_diagram directive which uses graphviz ---------
+
+graphviz_output_format = "svg"
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,15 +1,15 @@
 .. include:: ../README.rst
 
+..
+   NOTE: the "index" self-reference in the toctree below produces a warning
+         but makes sure it shows up in the left-side TOC like all the other pages
+
 .. toctree::
    :maxdepth: 2
    :hidden:
 
-   api/inheritance_diagram
-   api/modules
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   index
+   api
+   genindex
+   modindex
+   search
diff --git a/docs/inheritance_diagram.rst b/docs/inheritance_diagram.rst
@@ -0,0 +1,6 @@
+*************************
+Class Inheritance Diagram
+*************************
+
+.. inheritance-diagram:: junitparser.junitparser
+   :parts: -1