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

Add readthedocs config #12

Merged
merged 1 commit into from
May 13, 2024
Merged

Add readthedocs config #12

merged 1 commit into from
May 13, 2024

Conversation

janbridley
Copy link
Collaborator

Description

Readthedocs support has been added. I set fail on warning to True, so we need to be sure that the docs build without warning. I will set up CI to check this and assert we do not merge PRs that break the docs.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality and should be merged into the breaking branch

Checklist:

  • I am familiar with the Development Guidelines
  • The changes introduced by this pull request are covered by existing or newly introduced tests.
  • I have updated the changelog and added my name to the credits.

@janbridley janbridley marked this pull request as ready for review May 13, 2024 13:59
@janbridley janbridley merged commit ea82c81 into main May 13, 2024
0 of 4 checks passed
@janbridley janbridley deleted the admin/add-readthedocs branch May 13, 2024 13:59
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.

1 participant