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

Remove superfluous quality checks and update docs README #391

Merged

Conversation

uri-granta
Copy link
Collaborator

@uri-granta uri-granta commented Oct 28, 2021

The GitHub merge checks are now taking far too long. Speedups implemented so far:

  1. Remove the notebook check, as that's subsumed by the docs check (the former just executes the python in the notebooks, while the latter also generates the docs).
  2. Make the tox docs build rune make html just once. We were running it twice before due to bibtex which isn't important for finding errors; we'll still run it twice when we deploy new documentation (not 100% sure it's necessary but no harm).
  3. Add some notes in the docs README about how to generate the API docs without running the notebooks at all, which could save people lots of time when debugging docs issues.

@henrymoss henrymoss self-requested a review October 28, 2021 10:10
Copy link
Collaborator

@henrymoss henrymoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@uri-granta uri-granta marked this pull request as ready for review October 28, 2021 10:40
@uri-granta uri-granta merged commit 1d140c0 into secondmind-labs:develop Oct 28, 2021
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