Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactoring existing docs into four new areas: tutorials, how-tos, experiment guides, and the API reference. With contributions from @chriseclectic, @wshanks, @jaleipekoglu, and @spencerking. Main changes: - Added introduction tutorials - Added how-tos (this has a lot of room for future expansion) - Added cards linking to each documentation area on the index page - Organized experiment guides by type and with representative thumbnails - Moved detailed API docs such as Curve Analysis to tutorials - Consolidated previous calibrations guides into the new calibrations tutorial - Changed the `See Also` section in docstrings to render the rst directly instead of parsing modules - Closes #1014 by replacing `sphinx-panels` with `sphinx-design` - Upgraded `qiskit-sphinx-theme` to >=1.10 - Removed usage of `qiskit-ibmq-provider` in docs and linked to migration guide - Parallelized sphinx build run (CI docs build went from 13 minutes to 10:20) - Various fixes to remove all Sphinx build warnings and forces CI to fail if there's a warning (warnings might still exist on mac) - Cleaned up and removed unnecessary style and template files - Added commands `tox -edocs-parallel` for a parallel build and renamed no jupyter-execute command to `tox -edocs-minimal` --------- Co-authored-by: Will Shanks <willshanks@us.ibm.com> Co-authored-by: Will Shanks <wshaos@posteo.net>
- Loading branch information