Comments (4)
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.
Related Issues (20)
- Enable intersphinx extension HOT 1
- coef times MatrixOp done wrong sometimes
- Source text issue HOT 5
- Failed to load model class 'CircuitComposerModel' from module '@quantum/ibm-q-lab-widgets' HOT 4
- Update `aer_sources.txt` HOT 1
- Missing default thumbnail for tutorials after nbsphinx 0.9 release HOT 7
- Update deprecation policy and explain deprecation decorators
- Version list logic in docs doesn't account for patch releases properly HOT 1
- Epic - Copy documents from `qiskit/qiskit-metapackage` to `qiskit/qiskit-terra` HOT 8
- Epic - Move benchmark code out of metapackage HOT 2
- Epic - Move tutorials deployment out of metapackage
- Move Aer redirects to Cloudflare
- broken links in release notes HOT 6
- [blocked] Terra's How To and Explanations docs not hooked up
- Move docs translation config and infra to Terra
- Move docs version utils logic to Terra
- Set up Terra infrastructure to deploy docs
- Broken Link in Intro Tutorial
- Add deployment of metapackage shim to Terra
- Update README with notice of archiving
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 qiskit-metapackage.