search

Qiskit / qiskit-metapackage

Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://qiskit.org
Apache License 2.0
3.03k stars 750 forks source link

Move Sphinx extensions to `custom_extensions.py` #1673

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Summary

This keeps conf.py more digestible. It makes it easier/clearer to add quality checks for our extensions, e.g. adding a test_custom_extensions.py file.

Details and comments

No code was changed, only moved around.

Eric-Arellano commented 1 year ago

One extra optional addition to this PR that would be nice would be to add a comment to each custom extension function just to briefly explain what it does.

Good idea! Done.