Clean up the docs #183
Merged
Clean up the docs #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@joshcombes I still can't figure out how to get all of the links in notebooks working with nbsphinx-link, so I'm thinking we might just want to move the examples folder to the docs? (I'm waiting to merge in the other changes to the notebooks before doing this) With nbsphinx-link the .ipynb links work ok but I think the images would have to reside in both the examples and the docs subfolder. Even then, I'm not sure how we would be able to link to the superop document in We might be able to do something like suggested here spatialaudio/nbsphinx#170 |
stylewarning
approved these changes
Aug 5, 2019
|
This was quite a big change with lots of stuff going on. Try to encapsulate changes in smaller PRs. (Example: Delete Jupyter notebooks in a separate PR.) |
stylewarning
pushed a commit
that referenced
this pull request
Aug 19, 2019
* Process tomo notebook pointers to obs_est and parallel example. * Correct process tomo nb import and include in testing. * Show how to separate the parallel results. * Move and rename results_by_qubit_groups to obs_est. * Add helper to merge experiments, add to tomo notebooks. * minor tweak to nb test. * Add DFE example. * Change qc to noisy for last example process tomo * DFE refactor api and add all-in-one do_dfe method. * Add do_rb. * Add do_tomo and tqdm to obs_est, dfe. * address PR comments. * Remove warning import * Update after default group, replace accidental excluded import. * Update examples notebooks dfe arg order. * No need for test_qc after obs_est refactor. * small bugfixes. * Add tests. * Add do test for process tomo. * Add do_t1_or_t2 and do_rpe. * Make test more tolerant. * Standardize rpe estimate arg order, fix tests. * Expand do_rpe docstring. * Clean up the docs (#183) * Begin clean of docs, setup notebook linking. * Ignore superop autogen * Linked examples notebooks to module page for rb, dfe. * Add tomography notebooks and do_tomography. * Add examples and clean up warnings * Clean up classical logic docs. * Add progress bar to adder, include notebook in docs. * Fix compilation errors and typos. * Clean up doc errors in dfe. * Revert accidental template change. * Cleanup dm docstrings. * Clean up operator_tools docs. * Clean up op_est docs. * Finish resolving build warnings. * Notebook spellcheck and format fix. * Resolve last batch of warnings besides notebook interlinks. * Finish cleaning up and evaluating notebooks. * Fill out examples in quick start, shorten header title for obs_est. * Add do methods to docs. * Move examples to docs. * Move examples to docs and tweak the nb links. * Add a link to the examples folder. * Update example nb test link. * Remove reference to nblink
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This shouldn't have any changes to code, only to documentation. There were lots of sphinx formatting errors that need to be corrected, I rearranged a lot of the doc structure, and I evaluated all of the notebooks so that they would be rendered in the docs with cell output.