We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
If module named "modules",it will got wrong content.
dev === .. toctree:: :maxdepth: 4 conf handlers
Title "dev" is the directory name which I want to using sphinx to generating API documentation.
"conf" / "handlers" and "modules" in the same directory("dev").Directory structure like:
dev ├── conf │ ├── a │ └── b ├── handlers │ ├── c │ └── d ├── modules │ ├── e │ └── f
But,if rename "modules" to "module",it will work fine:
module package ============== Submodules ---------- module.e --------------------------- .. automodule:: module.e :members: :undoc-members: :show-inheritance:
Do it no matter module's name.
Make a directory named "modules",and using sphinx-apidoc command to parsing it.
The text was updated successfully, but these errors were encountered:
This is minimum reproducible steps:
$ ls $ touch modules.py $ sphinx-apidoc -o docs . Creating file docs/modules.rst. File docs/modules.rst already exists, skipping.
modules.rst is a default filename of index file which apidoc generates. So it is conflicted with target python module.
modules.rst
Sorry, something went wrong.
Fix sphinx-doc#5362: apidoc: Add --toc option to change the filen…
--toc
9ed6069
…ame of ToC
86abb57
Merge pull request #5375 from tk0miya/5362_apidoc_toc
dfbf90a
Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToC
I just added --tocfile option for renaming modules.rst (see #5375). Thank you for reporting!
--tocfile
No branches or pull requests
Problem
If module named "modules",it will got wrong content.
Title "dev" is the directory name which I want to using sphinx to generating API documentation.
"conf" / "handlers" and "modules" in the same directory("dev").Directory structure like:
But,if rename "modules" to "module",it will work fine:
Expected results
Do it no matter module's name.
Reproducible project / your project
Make a directory named "modules",and using sphinx-apidoc command to parsing it.
Environment info
The text was updated successfully, but these errors were encountered: