From 26473892e9ac84a43dc7cf6cdf7f8b1024df5db8 Mon Sep 17 00:00:00 2001 From: Kenneth Jao Date: Sun, 9 Jul 2023 23:43:44 -0500 Subject: [PATCH] Updated docs build process to make docs --- Makefile | 15 +++++++++++++-- build_docs | 2 -- docs/Doxyfile | 2 +- requirements.txt => docs/requirements.txt | 0 4 files changed, 14 insertions(+), 5 deletions(-) delete mode 100755 build_docs rename requirements.txt => docs/requirements.txt (100%) diff --git a/Makefile b/Makefile index e4967e0..4f7f3da 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,17 @@ -.PHONY: all +.PHONY: all docs install -all: install +all: install docs + +docs: SHELL:=/bin/bash +docs: + if [ ! -d "docs/.venv" ]; then python3 -m venv "docs/.venv"; fi + ( \ + source docs/.venv/bin/activate;\ + pip install -r docs/requirements.txt; \ + doxygen docs/Doxyfile; \ + sphinx-build -b html docs/source docs/build/html; \ + deactivate \ + ) install: install -d $(DEST_DIR)/ diff --git a/build_docs b/build_docs deleted file mode 100755 index 2c8fd33..0000000 --- a/build_docs +++ /dev/null @@ -1,2 +0,0 @@ -doxygen docs/Doxyfile -sphinx-build -b html docs/source docs/build/html diff --git a/docs/Doxyfile b/docs/Doxyfile index dbd5463..c5c9822 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -778,7 +778,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters diff --git a/requirements.txt b/docs/requirements.txt similarity index 100% rename from requirements.txt rename to docs/requirements.txt