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

chore: add .readthedocs.yaml #361

Merged
merged 1 commit into from
Sep 1, 2023
Merged

Conversation

alcarney
Copy link
Collaborator

Description (e.g. "Related to ...", etc.)

Unsurprisingly, #359 broke the docs build - especially when you consider it was still running on Python 2.7!

This PR adds a .readthedocs.yaml file, which is now the recommended way to configure builds on the platform.

The docs/requirements.txt file was generated using a poetry export --with docs command, so we'll have to remember to periodically update it - unless we find a way to automate its generation.

Code review checklist (for code reviewer to complete)

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
  • Title summarizes what is changing
  • Commit messages are meaningful (see this for details)
  • Tests have been included and/or updated, as appropriate
  • Docstrings have been included and/or updated, as appropriate
  • Standalone docs have been updated accordingly

@tombh
Copy link
Collaborator

tombh commented Aug 31, 2023

Ohh, that makes sense, it runs on a webhook, so it's not so easy to remember to keep up to date. Should be easy to automate updating the requirements.txt file if we keep forgetting to update it.

I think this branch went out of date with the merge of #360.

@tombh
Copy link
Collaborator

tombh commented Sep 1, 2023

Pyodide test passed on a re-run. It was a new flakey error, I should have noted it down, in case we see it again.

Edit: Noted the error in #367

@tombh tombh self-requested a review September 1, 2023 17:58
@tombh tombh merged commit d888d7f into openlawlibrary:main Sep 1, 2023
17 checks passed
@alcarney alcarney deleted the readthedocs branch September 1, 2023 18:00
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.

2 participants