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.

Sign up for GitHub

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

Jump to bottom

update docs generation & readthedocs config #131

Merged
merged 10 commits into from
Aug 29, 2023
Merged

update docs generation & readthedocs config #131

merged 10 commits into from
Aug 29, 2023

Conversation

syphar
Copy link
Member

@syphar syphar commented Aug 28, 2023 •
edited
Loading

  • drop sphinx spelling integration, IMO isn't worth fixing.
  • activated PR integration, dropped the doc-build GH action job
  • I updated the github webhook to include the pull request events, so we can have the doc test-build in PRs
  • added .readthedocs.yml for configuration
  • some fixes to make the docs build now

@syphar syphar self-assigned this Aug 28, 2023
@codecov
Copy link

codecov bot commented Aug 28, 2023 •
edited
Loading

Codecov Report

Merging #131 (4f6a2e9) into master (034a82d) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #131   +/-   ##
=======================================
  Coverage   99.65%   99.65%           
=======================================
  Files          26       26           
  Lines         878      878           
=======================================
  Hits          875      875           
  Misses          3        3

@syphar syphar changed the title add .readthedocs.yaml update docs generation & readthedocs config Aug 28, 2023
@syphar syphar marked this pull request as ready for review August 28, 2023 11:17
@syphar syphar mentioned this pull request Aug 29, 2023
Merged
@syphar syphar merged commit 3a48c02 into master Aug 29, 2023
16 checks passed
@syphar syphar deleted the new-docs-config branch August 29, 2023 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pcrock-thmdo pcrock-thmdo pcrock-thmdo approved these changes

Assignees

@syphar syphar

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@syphar @pcrock-thmdo