Note, that I am able to document the module in this way:
.. automodule:: shyft.api._api
:members:
:inherited-members:
:undoc-members:
but this is not preferred as it results in all the index references being
to:
shyft.api._api.SomeClass
And for the API in practice, these should be referenced as
`shyft.api.SomeClass` due to the import in the `__init__.py` file.
On Wednesday, February 28, 2018 at 2:12:23 PM UTC+1, John wrote:
>
> Hello,
>
> I just posted this before, but I don't see it appearing, apologies for a
> duplicate post.
>
> I am writing documentation for a boost:python project
> <https://github.com/statkraft/shyft-doc> with uses and underlying C++ .so
> file as a key module.
>
> It is read referenced within the `api.__init__.py` file in the following
> manner:
>
> from shyft.api._api import *
>
> I am trying every combination of :inherited-members:, :members:,
> :undoc-member:, etc.. but it seems only either functions/classes explicitly
> defined in the __init__.py file are exposed.
>
> How would I get the other modules/classes to be documented which exist
> within `_api.so`
>
> Thank you.
>
>
>
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
