Skip to content

Fix Read The Docs #506

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 7 commits into from
Aug 7, 2024
Merged

Fix Read The Docs #506

merged 7 commits into from
Aug 7, 2024

Conversation

kbourgoin
Copy link
Member

@kbourgoin kbourgoin commented Aug 5, 2024

...does what it says on the tin.

  • Fixes RTD builds
  • Renames the main testing workflow action to "Tests"
  • Adds tests and docs build badges to the README
  • Updates the release doc file to be reST and makes the formatting/language similar to other docs in the library

Fixes #456

@kbourgoin kbourgoin force-pushed the fix-docs branch 2 times, most recently from 55ed4eb to 9620f8d Compare August 5, 2024 17:50
@kbourgoin kbourgoin force-pushed the fix-docs branch 2 times, most recently from db1009d to 648186d Compare August 5, 2024 18:05
@kbourgoin kbourgoin force-pushed the fix-docs branch 2 times, most recently from e7b0f6d to 6dc786c Compare August 6, 2024 01:06
@kbourgoin
Copy link
Member Author

Hey @thornycrackers, @rachelannelise, or @lmontopo. I see you on #505 pretty recently. Mind giving this a quick gander? I fixed it to read the docs works again, as do the badges on the README.

I reformatted the recent entry a bit as well so that it builds correctly.

@kbourgoin kbourgoin changed the title [WIP] Fix Read The Docs Fix Read The Docs Aug 6, 2024
@thornycrackers
Copy link
Contributor

I ran a build with PYTHONPATH=$(pwd) sphinx-build -M html ./doc ./dist and everything seemed out build correctly with no warnings so 👍

@thornycrackers thornycrackers self-requested a review August 6, 2024 20:30
@kbourgoin kbourgoin merged commit 245bef4 into master Aug 7, 2024
7 checks passed
@kbourgoin kbourgoin deleted the fix-docs branch August 7, 2024 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Read the Docs webhook needs to be updated
2 participants