Skip to content
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

Update developer documentation dependencies #4485

Merged
merged 2 commits into from
Jan 16, 2024
Merged

Conversation

nllong
Copy link
Member

@nllong nllong commented Jan 16, 2024

Any background context you want to provide?

We were pretty far behind versions in Sphinx. Another PR was failing due to an incompatibility with an older version. Message was The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. and seen here

What's this PR do?

  • update sphinx
  • read in the spelling list so that sphinxcontrib-spelling can use it
  • Fix a few documentation errors, there are many more which we can address later.

How should this be manually tested?

  • locally run pip install..., tox -e docs

What are the relevant tickets?

n/a

Screenshots (if appropriate)

@nllong nllong requested a review from kflemin January 16, 2024 15:37
Copy link

Label error. Requires at least 1 of: Feature, Bug, Enhancement, Maintenance, Documentation, Performance, Do not publish. Found:

@nllong nllong added Maintenance Tag as maintenance if the issue relates to general cleanup, maintenance, etc. Do not delete label. Documentation and removed Maintenance Tag as maintenance if the issue relates to general cleanup, maintenance, etc. Do not delete label. labels Jan 16, 2024
@axelstudios axelstudios merged commit 9777ea1 into develop Jan 16, 2024
8 checks passed
@axelstudios axelstudios deleted the update-doc-depends branch January 16, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants