diff options
| author |   Klement Sekera <ksekera@cisco.com> | 2017-01-26 14:54:47 +0100 |
|---|---|---|
| committer |   Damjan Marion <dmarion.lists@gmail.com> | 2017-01-27 01:04:13 +0000 |
| commit | e7c034bf63afda379adcca1b810a4c671f4b3213 (patch) | |
| tree | 3e1b36f3e63a32ad5a7d8f5660d1d772318605db /test/doc/Makefile | |
| parent | a2ac467b845ae8d7995770a5bb5ca706452923c1 (diff) | |
make test: improve documentation generation
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>
Diffstat (limited to 'test/doc/Makefile')
| -rw-r--r-- | test/doc/Makefile | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/test/doc/Makefile b/test/doc/Makefile index 809abef8..ff96b5fd 100644 --- a/test/doc/Makefile +++ b/test/doc/Makefile @@ -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: |