Skip to content

Refactored docs #983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 67 commits into from
Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from 65 commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
17c4ab0
added warning and test
coruscating Jul 7, 2021
2ae42ed
test commit
coruscating Oct 5, 2022
9a9deb1
moved files around
coruscating Oct 5, 2022
f2dad3f
added install
coruscating Oct 5, 2022
88f0c8c
added files
coruscating Oct 5, 2022
71564bf
deleted rst files to make builds faster
coruscating Oct 5, 2022
7ddb781
add files
coruscating Oct 5, 2022
dbe6570
fixed code blocks
coruscating Oct 5, 2022
b02ef45
updated index
coruscating Oct 6, 2022
23afb57
changed index layout and added files
coruscating Nov 23, 2022
acbd986
try pinning sphinx version
coruscating Nov 24, 2022
795192f
minor changes
coruscating Nov 29, 2022
cb903c6
added subtitles
coruscating Nov 30, 2022
15fb6cf
renamed file
coruscating Nov 30, 2022
82a366b
updated calibrations
coruscating Dec 2, 2022
e36ed2e
upgraded qiskit-sphinx and updated landing page
coruscating Dec 6, 2022
b428d29
fixed build error
coruscating Dec 6, 2022
29e5a75
Adding tutorials and merging
coruscating Jan 12, 2023
5879d41
addressed comments
coruscating Jan 18, 2023
98c6830
requirement changes and minor edits
coruscating Feb 14, 2023
6b7fcd6
doc updates
coruscating Feb 14, 2023
63545d9
deleted duplicate documentation
coruscating Feb 14, 2023
270e150
added circuit visualization
coruscating Feb 14, 2023
72541e6
updated options
coruscating Feb 14, 2023
789ef9f
updated see also syntax and custom experiment tutorial
coruscating Feb 17, 2023
1d8a267
formatting fix
coruscating Feb 21, 2023
a021d8e
added job splitting howto
coruscating Feb 25, 2023
e8b3755
trying fix for dataclass duplicate object description warning
coruscating Feb 26, 2023
1a8405a
revert test change and updated howtos
coruscating Feb 26, 2023
e4ca9c4
addressing review comments
coruscating Feb 27, 2023
24baa82
changed jupyter-sphinx import and addressed comments
coruscating Feb 28, 2023
c03d088
fixed link
coruscating Feb 28, 2023
17ca5a5
fixed lists and testing doc version build
coruscating Mar 1, 2023
9f314b4
reverted test change and added release note
coruscating Mar 1, 2023
7ae937a
update experiment descriptions
coruscating Mar 1, 2023
c26afd6
updated calibrations tutorial
coruscating Mar 1, 2023
e6bc8f4
removed ibmq-provider code and added migration note
coruscating Mar 1, 2023
3dca480
downgrade sphinx version and update contributor guide
coruscating Mar 2, 2023
0980d6b
fix sphinx build command
coruscating Mar 2, 2023
ca7c937
force utf-8 output encoding
coruscating Mar 2, 2023
89f714c
restore sphinx version and remove some unnecessary template files
coruscating Mar 3, 2023
aff7079
updated links
coruscating Mar 3, 2023
cdbc362
fixed override warning and tutorial updates
coruscating Mar 5, 2023
534f284
added experiment icons and copy button
coruscating Mar 5, 2023
6479a20
restored path
coruscating Mar 5, 2023
fd381a6
fix attribute warnings
coruscating Mar 6, 2023
edee743
updated contributor guidelines
coruscating Mar 6, 2023
0cad585
Updated index
coruscating Mar 6, 2023
505f779
Reorganized guides and fixes
coruscating Mar 7, 2023
0e492df
Fixed sphinx-build parallelization
coruscating Mar 7, 2023
90c78de
Fix rebase mistakes
coruscating Mar 8, 2023
fd20875
Reverted unnecessary changes
coruscating Mar 8, 2023
e8c6b4f
Turn on -W and pin theme dependency to git repo
coruscating Mar 9, 2023
3de94b2
Merge branch 'main' into refactored-docs
coruscating Mar 9, 2023
fe8b9a6
Pin theme version to commit id
coruscating Mar 9, 2023
6d35140
Merge branch 'refactored-docs' of github.com:coruscating/qiskit-exper…
coruscating Mar 9, 2023
eea7382
change experiment guide to manual
coruscating Mar 10, 2023
34b938c
update jinja template
coruscating Mar 10, 2023
49d3016
skipped members throwing warnings
coruscating Mar 10, 2023
edb8ef8
fixed user manual section in docstrings
coruscating Mar 10, 2023
e1ea74c
turned off multiprocessing in default tox env
coruscating Mar 11, 2023
c2292ac
Merge main, update theme, and format footnotes
coruscating Mar 13, 2023
145ba35
fix merge conflicts
coruscating Mar 13, 2023
77c0a9f
fixed styling
coruscating Mar 13, 2023
2014a59
added docstring
coruscating Mar 13, 2023
e14dec1
addressed review comments
coruscating Mar 13, 2023
a0e2b40
minor edits
coruscating Mar 13, 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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ assignees: ''
<!-- ⚠️ If you do not respect this template, your issue will be closed -->
<!-- ⚠️ Make sure to browse the opened and closed issues to confirm this idea does not exist. -->

### What is the expected behavior?
### Suggested feature
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/NEW_EXPERIMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ your proposal. -->
## General details

### Experiment name
<!-- What is the experiment class name? This name will also be used in the API documentation and tutorial. -->
<!-- What is the experiment class name? This name will also be used in the documentation. -->

### Experiment type
<!-- What is the experiment type? Characterization, calibration, verification, validation, or other? -->
Expand Down Expand Up @@ -86,7 +86,7 @@ experiment data is displayed correctly in the results DB webpage
- [ ] Add unit testing for the experiment and analysis classes. If needed implement a mock-backend for your experiment
Include in your testing running the experiment in the context of `ParallelExperiment`
- [ ] Write API docs for all your API methods. Follow the guideline [here](https://github.com/Qiskit/qiskit-experiments/blob/main/CONTRIBUTING.md)
- [ ] Write a tutorial for your experiment. Follow the guideline [here](https://github.com/Qiskit/qiskit-experiments/blob/main/docs/tutorials/GUIDELINES.md)
- [ ] Write a user guide for your experiment. Follow the guideline [here](https://github.com/Qiskit/qiskit-experiments/blob/main/docs/GUIDELINES.md)
- [ ] Add a new release note. Follow the guideline [here](https://github.com/Qiskit/qiskit-experiments/blob/main/CONTRIBUTING.md#adding-a-new-release-note)
- [ ] Ask for a final review for the implementation, documentation and testing
- [ ] Celebrate!
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ jobs:
python -m pip install -U tox
sudo apt-get install -y pandoc graphviz
- name: Build Docs
run: tox -edocs
run: tox -edocs-parallel -- -W
- name: Compress Artifacts
run: |
mkdir artifacts
Expand Down
413 changes: 87 additions & 326 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

Loading