qiskit/tools
Frank Harkins 82b2da24ef
Make C API docs publishable (#14101)
* Get C API docs building

Co-authored-by: Max Rossmannek <rmax@ethz.ch>
Co-authored-by: Julien Gacon <jul@zurich.ibm.com>

* Separate `docs` from `docs-c` in `tox.ini`

* Move each group to its own page

* Reorganise docs page layout

* Fix some group namings

* Get enums working

* Update tox docs-clean

* Add exit codes page

* Add "Data types" heading

* Update docs/cdoc/index.rst

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

* QkObs docs and nits

* add bit term

note that the Members section should be updated to match doxygen's enum style before merging, the table is a placeholder

* Re-format index RST

* update members

* iterating on layout

* better enums (follow Glib style because it looks great)
* fix linebreaks
* minor fixes (brackets, missing whitespace)

* try fix tables

* Fix RST formatting quirks

* Install doxygen in CI

* document exit codes

* rm trailing ]

* more enum work

* Fix table

* QkExitCode and remove rustdoc links

* Rename exit codes page

* Update docs/cdoc/index.rst

Co-authored-by: Julien Gacon <gaconju@gmail.com>

* Fix xrefs and toc

* Fix CI?

* Remove bad xrefs

* Update docs/cdoc/qk-obs.rst

* Document doxygen is required for docs builds now

---------

Co-authored-by: Max Rossmannek <rmax@ethz.ch>
Co-authored-by: Julien Gacon <jul@zurich.ibm.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Julien Gacon <jules.gacon@googlemail.com>
Co-authored-by: Julien Gacon <gaconju@gmail.com>
2025-03-28 21:31:28 +00:00
..
pgo_scripts Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00
build_pgo.sh Test wheel builds during PR CI on demand (#13328) 2024-10-21 17:06:33 +00:00
build_standard_commutations.py Parameterize Commutation Checker (#13302) 2024-10-30 16:06:09 +00:00
docs_exclude.txt Add GitHub Actions documentation-deployment pipeline (#10610) 2023-08-14 19:35:14 +00:00
find_deprecated.py Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00
find_optional_imports.py Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00
find_stray_release_notes.py Remove consider-using-f-string lint rule and updates (#12423) 2024-06-19 07:05:56 +00:00
fix_mailmap.py Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00
install_rust.sh Promote linux aarch64 to tier 1 support (#13737) 2025-02-24 18:44:51 +00:00
install_rust_msrv.sh Promote linux aarch64 to tier 1 support (#13737) 2025-02-24 18:44:51 +00:00
install_ubuntu_c_dependencies.sh C API for ``SparseObservable`` (#13694) 2025-02-28 19:25:54 +00:00
install_ubuntu_docs_dependencies.sh Make C API docs publishable (#14101) 2025-03-28 21:31:28 +00:00
pylint_incr.py Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00
report_numpy_state.py Add script to report numpy env (#11798) 2024-02-14 22:35:41 +00:00
run_cargo_test.py Make sure that 'tox -erust' fails on bad RC. (#13753) 2025-02-04 15:23:50 +00:00
run_clang_format.sh C API for ``SparseObservable`` (#13694) 2025-02-28 19:25:54 +00:00
subunit_to_junit.py Disable pylint's import-error (#8973) 2022-10-21 20:02:46 +00:00
verify_headers.py C API for ``SparseObservable`` (#13694) 2025-02-28 19:25:54 +00:00
verify_images.py Pylint configuration to prevent accidentally committing debugging print statements (#13796) 2025-02-06 00:19:39 +00:00