Jeremy Maitin-Shepard
Jeremy Maitin-Shepard
This can actually already be controlled in two ways: - By defining `__all__`, but note that strangely that suppresses documenting entities without a docstring, even if they are listed in...
To me `__all__` seems to have some advantages, though: - you can specify it right in the module itself, and - it also controls wildcard imports. But it is true...
See here for an example `@export`: https://github.com/google/neuroglancer/blob/e7ad27d4cb1061b8b80ab2b008d05bedeeb92a8c/python/neuroglancer/viewer_state.py#L46
Currently apigen uses autodoc to decide which members of the module are documented. In general this is a bit tricky, because sometimes symbols are imported into a module just because...
I think rST templates are not ideal, because we need to know the complete list of entities to document before reading any of the rST, so we would need multiple...
The case of attributes (as opposed to functions or classes) is actually particularly difficult to support, because the docstring is only found via Sphinx's `ModuleAnalyzer` that parses the source code...
It seems like it wouldn't necessarily be too difficult to change the synopsis extraction function to also support breathe output.
I wonder why it isn't finding the paragraph containing `The SPI speed in Hz ie: 1000000 == 1Mhz`.
Should the `:linked` option be just on the `md-tab-item` directive or on the `md-tab-set` directive as well? I can see how it would be useful to specify an identifier for...
I agree that for members with just a short description, a separate page doesn't really make sense. I figured that over time the documentation would be expanded and almost everything...