Comments (5)
I can't understand from the description and screenshots what the problem is. Aren't libretro.api
and libretro.driver
on the same level of depth and aren't both being included in the toctree
? Within that structure what exactly is missing?
Do you mean that you were to have 2 children (libretro.api
and libretro.driver
) within the top level package libretro
and the subpackages are being listed with incorrect nestings and levels of depth? What seems to be happening is that you have docs for individual modules at the same level as docs for packages. There's nothing wrong with that. You also make extensive use of __all__
but in the base package's __init__.py
you only include the subpackages not the modules inside the top-level package. I'm unsure how autosummary would behave in that case.
from sphinx.
I can't understand from the description and screenshots what the problem is. Aren't
libretro.api
andlibretro.driver
on the same level of depth and aren't both being included in thetoctree
?
Yes, that's correct.
Within that structure what exactly is missing?
libretro.driver
should have doc pages for the submodules that it contains. It doesn't; they're not even generated.
Do you mean that you were to have 2 children (
libretro.api
andlibretro.driver
) within the top level packagelibretro
and the subpackages are being listed with incorrect nestings and levels of depth?
No, libretro.driver
is the only offender. All other packages are correctly nested (e.g. libretro.core
is a single module not nested in api
or driver
).
What seems to be happening is that you have docs for individual modules at the same level as docs for packages. There's nothing wrong with that.
I agree, that's not the issue I'm facing.
You also make extensive use of
__all__
but in the base package's__init__.py
you only include the subpackages not the modules inside the top-level package.
You mean this base package? I'm not sure what you mean here, could you elaborate?
from sphinx.
I don't believe this...renaming the offending package from libretro.driver
to libretro.impl
works around the issue!
Is the string driver
special at all?
from sphinx.
Using the name libretro.drivers
also works as expected.
from sphinx.
@thegamecracks was looking into this and offered this insight:
from sphinx.
Related Issues (20)
- LaTeX/ImageConverter: Regression with `data:` URIs HOT 1
- Have emoji and U+28FF working in sphinx ``lualatex`` generated for titles and code HOT 6
- Should `defusedxml` be moved to the runtime dependencies? HOT 5
- When compiling linux kernel(drm-tis), failed at module `docutils.nodes` for no attribute โreprunicodeโ HOT 11
- sphinx-build hard-codes the python path into the exe HOT 7
- ext.napoleon to work with ext.todo HOT 2
- `:loading: embed` on images does not work as expected HOT 7
- ``todo`` directive treat repeated special characters as headers
- toc_object_entries uses language (Python) scoping instead of documentation scoping HOT 2
- TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html HOT 1
- Index pages use `–` but it can not be used in ePub HOT 3
- Intersphinx Mapping link not working with Plotly objects in signature HOT 4
- Internationalization doc mentions deprecated transifex-client HOT 1
- 7.3.7: missing `defusedxml` install time dependency HOT 2
- THYDUX COIN ๐ ๐ฅ
- Multiple labels inside math directives HOT 1
- LaTeX: footnote mark may indicate "Page N, M" but footnote M is already on page N
- Gettext builder cannot extract 'option' directive HOT 4
- `autodoc_class_signature = "separated"` cause a warning for enum with no `__init__` HOT 12
- [search] issues with the new HTML search algorithm HOT 12
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 sphinx.