docs: support deleting automatically generated files via make clean

Graviti-AI · Nov 24, 2021 · 8c2c3c6 · 8c2c3c6
1 parent 8f537e1
commit 8c2c3c6
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -72,7 +72,7 @@ instance/
 docs/_build/
 
 # Documentation generated rst files
-docs/source/reference/api/api_rst/
+docs/source/reference/api/generated/
 
 # PyBuilder
 target/

diff --git a/docs/Makefile b/docs/Makefile
@@ -18,3 +18,7 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+	-rm -rf $(SOURCEDIR)/reference/api/generated/
diff --git a/docs/source/reference/api/opendataset.rst b/docs/source/reference/api/opendataset.rst
@@ -6,7 +6,7 @@ tensorbay.opendataset
 
 .. autosummary::
    :nosignatures:
-   :toctree: api_rst/
+   :toctree: generated/
 
    AADB
    AnimalPose5