Skip to content

Commit

Permalink
Remove Pulse library URL renaming in docs (#13107) (#13132)
Browse files Browse the repository at this point in the history
(cherry picked from commit c5e9f8a)

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
mergify[bot] and Eric-Arellano authored Sep 11, 2024
1 parent 52fdbef commit 56a5352
Showing 1 changed file with 0 additions and 17 deletions.
17 changes: 0 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,6 @@
autosummary_generate = True
autosummary_generate_overwrite = False

# The pulse library contains some names that differ only in capitalization, during the changeover
# surrounding SymbolPulse. Since these resolve to autosummary filenames that also differ only in
# capitalization, this causes problems when the documentation is built on an OS/filesystem that is
# enforcing case-insensitive semantics. This setting defines some custom names to prevent the clash
# from happening.
autosummary_filename_map = {
"qiskit.pulse.library.Constant": "qiskit.pulse.library.Constant_class.rst",
"qiskit.pulse.library.Sawtooth": "qiskit.pulse.library.Sawtooth_class.rst",
"qiskit.pulse.library.Triangle": "qiskit.pulse.library.Triangle_class.rst",
"qiskit.pulse.library.Cos": "qiskit.pulse.library.Cos_class.rst",
"qiskit.pulse.library.Sin": "qiskit.pulse.library.Sin_class.rst",
"qiskit.pulse.library.Gaussian": "qiskit.pulse.library.Gaussian_class.rst",
"qiskit.pulse.library.Drag": "qiskit.pulse.library.Drag_class.rst",
"qiskit.pulse.library.Square": "qiskit.pulse.library.Square_fun.rst",
"qiskit.pulse.library.Sech": "qiskit.pulse.library.Sech_fun.rst",
}

# We only use Google-style docstrings, and allowing Napoleon to parse Numpy-style docstrings both
# slows down the build (a little) and can sometimes result in _regular_ section headings in
# module-level documentation being converted into surprising things.
Expand Down

0 comments on commit 56a5352

Please sign in to comment.