CI for linting docs #1080
Draft
CI for linting docs #1080
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
also fixed broken links and bumped some package versions
renamed env to `docs-lint`, changed arxiv link to abstract instead of pdf, and various other fixes
linux build is failing on the minimal conf so I'm adding more lines back in. hard to debug locally because the mac build has a different set of warnings.
this syncs up the names on the manuals page and the API experiments page
|
I'm having a hard time with the new |
coruscating
added a commit
that referenced
this pull request
Mar 22, 2023
### Summary This PR is essentially the documentation fixes from #1080 since the lint CI pipeline needs more work. ### Details and comments - The docs are no longer incompatible with the newest sphinx-autodoc-typehints so the version pin from #1017 has been removed. This closes #1018. - Updates curve analysis tutorial to the newest version (#983 had accidentally reverted to an older version) - Changes arxiv autolinks from pdfs to abstract page to be more user friendly - Renames the new ExperimentData how-to to rerunning analysis and adds additional info on using `add_data` - Moved functions from `curve_analysis/data_processing.py` to `utils.py` - Changes benchmarking experiments to verification experiments on the manual page to match the library API page - Added referenced classes and functions that weren't included in the docs - Various formatting fixes for passing Sphinx nitpick mode
envs for ease of reading
also turns off nitpick mode
|
|
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.
Summary
Added linting of Sphinx docs to the lint CI job with the tox environment
docs-lint. The job will fail on broken references and links.Details and comments
docs/lint/conf.pyis added for this linting setting. It currently has a manual list of regex objects to ignore, because there are a lot of deprecated objects in the release notes that need to be manually updated or added to the ignore list.