Bugfix For ReadTheDocs and Documentation Build Updates #331
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
Removed a reference to the deprecated "sample" which was causing an import error.
pygsti.evotype->pygst.evotypes
crosstalk module uses pcalg and throws an import error if not installed.
pcalg is needed for the crosstalk module.
The _dbcoordinates attribute doesn't seem to be getting included when pickling and unpickling dataset objects which happens under the hood when using MPI. Temporary patch until I identify the longer term fix.
Add the language to address deprecation warning in sphinx
This commit shift the sphinx automatic documentation generation based on extracted docstrings to use the autoapi extensions. This runs statically by analyzing the source code instead of by performing module imports, so this should in principle run a good deal faster and alleviate resource limitations on RTD. Also included are some custom tweaks to the default autoapi documentation template to (in my opinion) look a bit better.
The keywords used for sphinx cross-referencing in many docstrings was incorrect which was raising a large number of warnings. This is a wholesale find and replace of all of those instances with the corrected ones.
First round of fixes for sphinx/rst formatting errors related to docstrings. More to come...
Add the sphinx rtd theme package and autoapi package to the requirements file for doc building.
This commit updates the minimum version for sphinx used for building the documentation. It also adds a yaml file for the RTD configuration settings in accordance with new requirements from them. They have deprecated the ability to configure build settings through the online dashboard and will disable builds w/o this file in the fall.
There appears to be an incompatibility between sphinx 7+ and one of the themes we're using so pinning the sphinx version to one which successfully builds locally.
Force a more recent version of the sphinx rtd theme to be used than the default on RTD and also remove an unused requirements file from the doc folder.
This is another round of updates to fix a large number of sphinx build errors and warnings related to malformed rst markup.
Another batch of docstring fixes.
Somehow this import got deleted, not sure how (maybe I accidentally did this during one of the find and replaces?) but this should sync things back up with master.
sserita
approved these changes
Aug 10, 2023
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 PR includes the following:
Once this PR is approved I'll update the settings on RTD to switch our documentation builds from running against this bugfix branch back to develop and master.