mirror of https://github.com/Qiskit/qiskit.git
97788f05b6
* switched from sphinx.ext.viewcode to sphinx.ext.linkcode
* removed extra line
* Add section header for source code links
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* removed docstring
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* update return string
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* added back blank line
* Added a method to determine the GitHub branch
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* add blank line
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* remove print statement
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* Try to fix error for contextlib file
We got this stacktrace:
Traceback (most recent call last):
File "/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/sphinx/events.py", line 96, in emit
results.append(listener.handler(self.app, *args))
File "/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/sphinx/ext/linkcode.py", line 55, in doctree_read
uri = resolve_target(domain, info)
File "/home/vsts/work/1/s/docs/conf.py", line 216, in linkcode_resolve
file_name = PurePath(full_file_name).relative_to(repo_root)
File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/pathlib.py", line 908, in relative_to
raise ValueError("{!r} does not start with {!r}"
ValueError: '/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/contextlib.py' does not start with '/home/vsts/work/1/s'
We shouldn't even attempt to generate a link for the file contextlib.py
* Try to fix error for Jenkins run #20240221.52
New build failed with this stacktrace:
Traceback (most recent call last):
File "/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/sphinx/events.py", line 96, in emit
results.append(listener.handler(self.app, *args))
File "/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/sphinx/ext/linkcode.py", line 55, in doctree_read
uri = resolve_target(domain, info)
File "/home/vsts/work/1/s/docs/conf.py", line 215, in linkcode_resolve
full_file_name = inspect.getsourcefile(obj)
File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/inspect.py", line 696, in getsourcefile
filename = getfile(object)
File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/inspect.py", line 665, in getfile
raise TypeError('{!r} is a built-in class'.format(object))
TypeError: <class 'builtins.CustomClassical'> is a built-in class
So I added a condition that the obj should not be a built-in
* Check that qiskit in module name sooner
* moved valid code object verification earlier
* added try except statement to getattr call
* added extra try/except block
* Also support Azure Pipelines
* removed unused import
* Revert Azure support to keep things simple
* added extra "/" to final URL
* Move GitHub branch logic to GitHub Action
* switched to importlib and removed redundant block of code
* Apply suggestions from code review
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
* added back spaces
* Clarify docs_deploy GitHub logic
1. Remove misleading PR conditional. This worfklow doesn't even run in PRs. It was bad copy-pasta from the runtime repo
2. Clarify why we point tag builds to their stable branch name
* Use pathlib for relativizing file name
* Fix relative_to() path
* Remove tox prefix
---------
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| _templates/autosummary | ||
| apidoc | ||
| source_images | ||
| Makefile | ||
| conf.py | ||
| index.rst | ||
| release_notes.rst | ||