Support templating about apidoc HOT 5 OPEN

This is not currently possible as the original Sphinx application that this extension utilizes, sphinx-apidoc, does not support templates or the likes. If we wanted to support this feature, we'd need to essentially vendor and rewrite that application or modify the application upstream so that we would get support for free with the next version of Sphinx. I'd be happy to help produce a PRs for either approach but it's not important enough for me to do solo.

from apidoc.

Ok, I dig into it to see what can be done

• module first is an option of sphinx apidoc: --module-first
• the toc file can be skiped and manually recreated, that pretty much do the job.

So for the moment, sadly, I have disabled sphinx-contrib/apidoc and added this in my general makefile:

DOCS_EXCLUSION=$(foreach m, $(MODULES), $m/tests)

docs: clean-docs sdist docs-generate-apidoc docs-run-sphinx

docs-generate-apidoc:
	pipenv run sphinx-apidoc \
		--force \
		--separate \
		--module-first \
		--doc-project "API Reference" \
		-o docs/source/reference \
		$(PACKAGE_NAME) \
			$(DOCS_EXCLUSION)

docs-run-sphinx:
	pipenv run make -C docs/ html

clean-docs:
	rm -rf docs/_build docs/source/reference/*.rst

docs-open:
	xdg-open docs/_build/html/index.html

I'll see if I have time to exposes this in sphinxcontrib-apidoc in the future. Thanks for this package anyway!

from apidoc.

Is the solution to provide additional additional arguments to sphinx-apidoc? As far as I can tell --doc-project is ignored unless you use --full. However #9 adds an apidoc_module_first option and lets you specify whichever additional arguments you'd like.

from apidoc.

Is the solution to provide additional additional arguments to sphinx-apidoc? As far as I can tell --doc-project is ignored unless you use --full. However #9 adds an apidoc_module_first option and lets you specify whichever additional arguments you'd like.

Indeed, that's what I'd take out of this. @gsemet Thoughts?

from apidoc.

seems great! thanks will try it asap

from apidoc.