can we drop the submodules under the circuit package (true for other ones as well) about qiskit-metapackage HOT 4 CLOSED

In general, the folder within the folders navigation of the autodoc is a bit confusing.

from qiskit-metapackage.

To put things in context, that hierarchy:

X package
  Subpackages
    X.Y
  Submodules
    X.Z

is actually the default Sphinx (autodoc) one. In the pre-meta-qiskit documentation, we used a nifty third party package for customizing the automatic documentation template (in this case, template means "how the elements are structured around", not CSS template) and the TOC - we could explore using it again, although it seems support for recent Sphinx versions and namespaces might be a bit lacking (and we would need to come up with a new template from scratch, as the format we used before was not compatible with the newest versions).

In the meantime, the TOC navigation might get a bit better by fixing #67, reducing the confusion a bit?

from qiskit-metapackage.

sure but something like https://www.tensorflow.org/api_docs/python to me is simpler to see where we are in the API documentation or even https://pytorch.org/docs/stable/

from qiskit-metapackage.

@carlosazaustre I looked into this a bit.

sphinx-contrib/apidoc has a stale enhancement issue to support this use case.

This forum discussion addresses the issue at the top level, but does not address the issue at the submodule level.

I haven't come up with a solution.

from qiskit-metapackage.