aboutsummaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>2021-08-19 11:38:06 +0200
committerDave Wallace <dwallacelf@gmail.com>2021-10-13 23:22:32 +0000
commit9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 (patch)
tree3cca19635417e28ae381d67ae31c75df2925032d /Makefile
parentf47122e07e1ecd0151902a3cabe46c60a99bee8e (diff)
docs: better docs, mv doxygen to sphinx
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile50
1 files changed, 19 insertions, 31 deletions
diff --git a/Makefile b/Makefile
index 28e44ce9095..1456ef2b720 100644
--- a/Makefile
+++ b/Makefile
@@ -209,9 +209,9 @@ help:
@echo " checkstyle-test-diff - check test framework coding style (only changed files)"
@echo " checkstyle-api - check api for incompatible changes"
@echo " fixstyle - fix coding style"
- @echo " doxygen - (re)generate documentation"
- @echo " bootstrap-doxygen - setup Doxygen dependencies"
- @echo " wipe-doxygen - wipe all generated documentation"
+ @echo " doxygen - DEPRECATED - use 'make docs'"
+ @echo " bootstrap-doxygen - DEPRECATED"
+ @echo " wipe-doxygen - DEPRECATED"
@echo " checkfeaturelist - check FEATURE.yaml according to schema"
@echo " featurelist - dump feature list in markdown"
@echo " json-api-files - (re)-generate json api files"
@@ -451,11 +451,13 @@ test-dep:
.PHONY: test-doc
test-doc:
- @make -C test doc
+ @echo "make test-doc is DEPRECATED: use 'make doc'"
+ sleep 300
.PHONY: test-wipe-doc
test-wipe-doc:
- @make -C test wipe-doc
+ @echo "make test-wipe-doc is DEPRECATED"
+ sleep 300
.PHONY: test-cov
test-cov:
@@ -667,42 +669,28 @@ checkfeaturelist: centos-pyyaml
# Build the documentation
#
-# Doxygen configuration and our utility scripts
-export DOXY_DIR ?= $(WS_ROOT)/doxygen
-
-define make-doxy
- @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
-endef
-
.PHONY: bootstrap-doxygen
bootstrap-doxygen:
- $(call make-doxy)
+ @echo "make bootstrap-doxygen is DEPRECATED"
+ sleep 300
.PHONY: doxygen
-doxygen: bootstrap-doxygen
- $(call make-doxy)
+doxygen: docs
+ @echo "make doxygen is DEPRECATED: use 'make docs'"
+ sleep 300
.PHONY: wipe-doxygen
wipe-doxygen:
- $(call make-doxy)
+ @echo "make wipe-doxygen is DEPRECATED"
+ sleep 300
-# Sphinx Documents
-export DOCS_DIR = $(WS_ROOT)/docs
-export VENV_DIR = $(WS_ROOT)/sphinx_venv
-export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
-
-.PHONY: docs-venv
-docs-venv:
- @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
+.PHONY: docs-%
+docs-%:
+ @make -C $(WS_ROOT)/docs $*
.PHONY: docs
-docs: $(DOCS_DIR)
- @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
-
-.PHONY: docs-clean
-docs-clean:
- @rm -rf $(DOCS_DIR)/_build
- @rm -rf $(VENV_DIR)
+docs:
+ @make -C $(WS_ROOT)/docs docs
.PHONY: pkg-verify
pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps