Skip to content
This repository was archived by the owner on Aug 19, 2023. It is now read-only.

Fix Sphinx docs issues with extlinks #1743

Merged
1ucian0 merged 12 commits into from
Jun 5, 2023
Merged

Fix Sphinx docs issues with extlinks #1743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a40a25b
WIP: debug import failure for dagcircuits.exceptions
Eric-Arellano May 22, 2023
7636981
Merge branch 'master' of https://github.com/Qiskit/qiskit-metapackage…
Eric-Arellano May 23, 2023
fd8c1b1
Revert "WIP: debug import failure for dagcircuits.exceptions"
Eric-Arellano May 24, 2023
7440da8
Try double backticks
Eric-Arellano May 24, 2023
a4a72c2
Fix issue with extlink
Eric-Arellano May 24, 2023
8819060
Merge branch 'master' of https://github.com/Qiskit/qiskit-metapackage…
Eric-Arellano May 24, 2023
3415c0e
Fix loading of versionutils
Eric-Arellano May 24, 2023
e13a773
Merge branch 'master' of https://github.com/Qiskit/qiskit-metapackage…
Eric-Arellano May 30, 2023
46d00c1
Revert maintainers guide change for now
Eric-Arellano May 30, 2023
38c4687
Merge branch 'master' of https://github.com/Qiskit/qiskit-metapackage…
Eric-Arellano May 31, 2023
bd655bd
Add Terra back
Eric-Arellano May 31, 2023
22a181b
Merge branch 'master' into fix-exceptions-import
1ucian0 Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,12 @@
# -- Configuration for extlinks extension ------------------------------------
# Refer to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
extlinks = {
"pull_terra": ("https://github.com/Qiskit/qiskit-terra/pull/%s", "#"),
Copy link
Copy Markdown
Collaborator Author

@Eric-Arellano Eric-Arellano May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused

Copy link
Copy Markdown
Contributor

@HuangJunye HuangJunye May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found many release notes refer to terra issues but the links are normal links. See https://qiskit.org/documentation/release_notes.html#bug-fixes

Screenshot 2023-05-31 at 15 59 02

For example #9798 <https://github.com/Qiskit/qiskit-terra/issues/9798> in:

https://github.com/Qiskit/qiskit-terra/blob/main/releasenotes/notes/0.24/fix-9798-30c0eb0e5181b691.yaml

Copy link
Copy Markdown
Contributor

@HuangJunye HuangJunye May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we keep others, I think we should keep pull_terra and advertise the usage of this plugin. If not, perhaps we can change where pull_aer and pull_ibmq-provider are used to normal links and get rid of the extlinks altogether.

Copy link
Copy Markdown
Collaborator Author

@Eric-Arellano Eric-Arellano May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, added back.

"pull_aer": ("https://github.com/Qiskit/qiskit-aer/pull/%s", "#"),
"pull_ibmq-provider": ("https://github.com/Qiskit/qiskit-ibmq-provider/pull/%s", "#"),
"pull_terra": ("https://github.com/Qiskit/qiskit-terra/pull/%s", "qiskit-terra #%s"),
"pull_aer": ("https://github.com/Qiskit/qiskit-aer/pull/%s", "qiskit-aer #%s"),
"pull_ibmq-provider": (
"https://github.com/Qiskit/qiskit-ibmq-provider/pull/%s",
"qiskit-ibmq-provider #%s",
),
Comment on lines +132 to +136
Copy link
Copy Markdown
Collaborator Author

@Eric-Arellano Eric-Arellano May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are used in release_notes.py, like this:

 Refactor thread management :pull_aer:`50`

This changes the text that we will render. Before, #50. Now, qiskit-aer #50.

Copy link
Copy Markdown
Contributor

@HuangJunye HuangJunye May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know this extension exist. It's quite handy. We should use it more.

}

# -- Options for HTML output -------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ build-backend = "setuptools.build_meta"
[tool.black]
line-length = 100
target-version = ["py37", "py38", "py39", "py310", "py311"]
extend-exclude = "test/benchmarks/"
extend-exclude = ["test/benchmarks/", "docs/plot_directive/"]

[tool.isort]
profile = "black"
extend_skip_glob = "test/benchmarks/**"
extend_skip_glob = ["test/benchmarks/**", "docs/plot_directive/**"]