Updated docs build process to make docs
This commit is contained in:
parent
cdd35acd34
commit
45e8e274cb
15
Makefile
15
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:
|
||||||
install -d $(DEST_DIR)/
|
install -d $(DEST_DIR)/
|
||||||
|
|||||||
@ -1,2 +0,0 @@
|
|||||||
doxygen docs/Doxyfile
|
|
||||||
sphinx-build -b html docs/source docs/build/html
|
|
||||||
@ -778,7 +778,7 @@ WARNINGS = YES
|
|||||||
# will automatically be disabled.
|
# will automatically be disabled.
|
||||||
# The default value is: YES.
|
# 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
|
# 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
|
# potential errors in the documentation, such as not documenting some parameters
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user