Comments (5)
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 anapidoc_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.
Related Issues (12)
- validate function/method params against docstrings HOT 1
- Passing multiple apidoc_module_dir's
- Cython modules that use __init__.pyx instead of __init__.py are broken HOT 1
- Cannot include private methods with apidoc_extra_args HOT 5
- 0.3.0: test suite fails HOT 2
- warnings created from derived classes when constructor has no docstring HOT 2
- Is it possible to run example code to generate an image? HOT 1
- Add support for Python 3.12 HOT 1
- WARNING: Inline literal start-string without end-string. HOT 2
- Support more config options HOT 2
- Call to `pbr.version.VersionInfo` raises exception on import HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from apidoc.