Skip to content
Snippets Groups Projects
Commit 6aa5f080 authored by Antoine Lambert's avatar Antoine Lambert
Browse files

docs/Makefile: Fix warning about file not being included in any toctree

Do not generate TOC with sphinx-apidoc.

Mark the apidoc/swh.rst file as orphan.
parent 955b1800
No related branches found
No related tags found
No related merge requests found
......@@ -13,7 +13,7 @@ INSTALL_PERMS = g+rwX
SPHINXAPIDOC = sphinx-apidoc
APIDOC_DIR = apidoc
APIDOC_OPTS = --ext-viewcode --separate
APIDOC_OPTS = --ext-viewcode --separate --no-toc
APIDOC_EXCLUDES = */tests */tests/* */*/tests/* */*/*/tests/*
APIDOC_EXCLUDES += */migrations */migrations/* */*/migrations/* */*/*/migrations/*
APIDOC_EXCLUDES += */wsgi.py */*/wsgi.py */*/*/wsgi.py */*/*/wsgi.py
......@@ -39,6 +39,8 @@ apidoc-stamp: links-stamp
$(SWHPKGDIR) \
$(APIDOC_SWH_EXCLUDES)
touch $@
# remove warning about swh.rst not being included in any toctree
sed -i '1s/^/:orphan:\n\n/' $(APIDOC_DIR)/swh.rst
images-stamp:
$(MAKE) -C images
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment