9ad39c026c
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>
103 lines
2.7 KiB
Makefile
103 lines
2.7 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
# We support MacOS for docs generation
|
|
ifeq ($(shell uname),Darwin)
|
|
OS_ID = darwin
|
|
endif
|
|
|
|
# These should be passed in by the root Makefile
|
|
WS_ROOT ?= $(CURDIR)/..
|
|
BR ?= $(WS_ROOT)/build-root
|
|
DOCS_DIR ?= $(WS_ROOT)/docs
|
|
|
|
VENV_DIR ?= $(DOCS_DIR)/venv
|
|
SPHINX_SCRIPTS_DIR ?= $(WS_ROOT)/docs/scripts
|
|
|
|
# Work out the OS if we haven't already
|
|
OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
|
|
OS_VERSION ?= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
|
|
PIP_VERSION ?= $(shell grep 'PIP_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2)
|
|
PIP_TOOLS_VERSION ?= $(shell grep 'PIP_TOOLS_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2)
|
|
|
|
PYTHON ?= "python3"
|
|
|
|
DOC_DEB_DEPENDS = enchant
|
|
DOC_RPM_DEPENDS = enchant
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS = --keep-going -n -W
|
|
SPHINXBUILD = sphinx-build
|
|
SPHINXPROJ = fdio-vpp
|
|
SOURCEDIR = .
|
|
BUILDDIR = ${BR}/docs
|
|
BUILDDIR_SRC = ${BUILDDIR}/src
|
|
BUILDDIR_OUT = ${BUILDDIR}/html
|
|
SCRIPTS_DIR = _scripts
|
|
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
.PHONY: help
|
|
help:
|
|
@( \
|
|
. ${VENV_DIR}/bin/activate; \
|
|
$(SPHINXBUILD) --help ;\
|
|
)
|
|
|
|
.PHONY: checkdeps
|
|
checkdeps:
|
|
@echo "Checking whether dependencies for Docs are installed..."
|
|
ifeq ($(OS_ID),ubuntu)
|
|
@set -e; inst=; \
|
|
for i in $(DOC_DEB_DEPENDS); do \
|
|
dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \
|
|
done; \
|
|
if [ "$$inst" ]; then \
|
|
sudo apt-get update; \
|
|
sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \
|
|
fi
|
|
else ifneq ("$(wildcard /etc/redhat-release)","")
|
|
@sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
|
|
endif
|
|
|
|
.PHONY: spell
|
|
spell: clean checkdeps venv ${BUILDDIR_SRC}
|
|
@( \
|
|
. ${VENV_DIR}/bin/activate; \
|
|
make -C ${SCRIPTS_DIR} generate && \
|
|
$(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \
|
|
)
|
|
|
|
.PHONY: venv
|
|
venv:
|
|
@( \
|
|
if [ ! -d ${VENV_DIR} ]; then \
|
|
${PYTHON} -m venv ${VENV_DIR}; \
|
|
. ${VENV_DIR}/bin/activate; \
|
|
${PYTHON} -m pip install pip==${PIP_VERSION}; \
|
|
${PYTHON} -m pip install pip-tools==${PIP_TOOLS_VERSION}; \
|
|
${PYTHON} -m pip install -r ${WS_ROOT}/test/requirements-3.txt; \
|
|
fi; \
|
|
)
|
|
|
|
${BUILDDIR_SRC}:
|
|
@mkdir -p ${BUILDDIR_SRC}
|
|
@cp -r $(SOURCEDIR) ${BUILDDIR_SRC}
|
|
@cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \;
|
|
|
|
.PHONY: docs
|
|
docs: clean venv ${BUILDDIR_SRC}
|
|
@( \
|
|
. ${VENV_DIR}/bin/activate; \
|
|
make -C ${SCRIPTS_DIR} generate && \
|
|
$(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \
|
|
)
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
@rm -rf $(BUILDDIR)
|
|
@make -C ${SCRIPTS_DIR} clean
|
|
|
|
.PHONY: build
|
|
build: docs
|
|
|