ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make test: improve documentation generation

Browse Source 
Refactor the text to work around sphinx bug to show a proper
table of contents.

Change-Id: I546656ef77a95637ad7c6bf239f26262a4f306dc
Signed-off-by: Klement Sekera <ksekera@cisco.com>
This commit is contained in:
Klement Sekera
2017-01-26 14:54:47 +01:00
committed by Damjan Marion
parent a2ac467b84
commit e7c034bf63
4 changed files with 432 additions and 430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
test/doc/Makefile
View File

@ -16,7 +16,6 @@ PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILD_DOC_DIR)/.sphinx-cache $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(API_DOC_GEN_DIR) -c $(SRC_DOC_DIR)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
INDEX_REL_PATH:=$(shell realpath --relative-to=$(API_DOC_GEN_DIR) $(SRC_DOC_DIR)/index.rst)
IN_VENV:=$(shell if pip -V | grep "virtualenv" 2>&1 > /dev/null; then echo 1; else echo 0; fi)
.PHONY: verify-virtualenv
@ -28,9 +27,10 @@ endif
.PHONY: regen-api-doc
regen-api-doc: verify-virtualenv
@mkdir -p $(API_DOC_GEN_DIR)
#@echo ".. include:: $(INDEX_REL_PATH)" > $(API_DOC_GEN_DIR)/index.rst
@cp $(SRC_DOC_DIR)/index.rst $(API_DOC_GEN_DIR)
sphinx-apidoc -o $(API_DOC_GEN_DIR) ..
@cp $(SRC_DOC_DIR)/indices.rst $(API_DOC_GEN_DIR)
@cp $(SRC_DOC_DIR)/overview.rst $(API_DOC_GEN_DIR)
sphinx-apidoc -o $(API_DOC_GEN_DIR) -H "Module documentation" ..
.PHONY: help
help:

432
test/doc/index.rst
View File

File diff suppressed because it is too large Load Diff

6
test/doc/indices.rst Normal file
View File

@ -0,0 +1,6 @@
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

418
test/doc/overview.rst Normal file
View File

File diff suppressed because it is too large Load Diff