maint: implementing autoapi and general maintenance (#167)

Author: clatapie

doc/Makefile

@@ -16,11 +16,20 @@ 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
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+# TODO: these lines of code until $(SPHINXBUILD) should be removed once the feature branch is merged
+	pip freeze > temp_req.txt;
+	@if grep -q "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi" temp_req.txt;\
+		then\
+			echo found;\
+		else\
+			pip uninstall --yes sphinx-autoapi;\
+			pip install "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable";\
+	fi
+	rm temp_req.txt;\
+	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O);
 
 clean:
 	rm -rf $(BUILDDIR)/*
-	find . -type d -name "_autosummary" -exec rm -rf {} +
 
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/make.bat

@@ -10,6 +10,13 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=_build
 
+REM TODO: these lines of code should be removed once the feature branch is merged
+for /f %%i in ('pip freeze ^| findstr /c:"sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi"') do set is_custom_sphinx_autoapi_installed=%%i
+if NOT "%is_custom_sphinx_autoapi_installed%" == "sphinx-autoapi" (
+	pip uninstall --yes sphinx-autoapi
+	pip install "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable")
+REM TODO: these lines of code should be removed once the feature branch is merged
+
 if "%1" == "" goto help
 if "%1" == "clean" goto clean
 if "%1" == "linkcheck" goto linkcheck