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

Don't store docs as CI build artifacts #221

Merged
merged 1 commit into from
Dec 1, 2020
Merged

Don't store docs as CI build artifacts #221

merged 1 commit into from
Dec 1, 2020

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Dec 1, 2020

The idea was to be able to download them and inspect for any issues (or
reuse in a deploy action). In practice, both are a lot more work than
just rebuilding the docs (locally or on the deploy jobs). So we can stop
storing them.

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

The idea was to be able to download them and inspect for any issues (or
reuse in a deploy action). In practice, both are a lot more work than
just rebuilding the docs (locally or on the deploy jobs). So we can stop
storing them.
@leouieda leouieda merged commit 7424c0d into master Dec 1, 2020
@leouieda leouieda deleted the docs-cache branch December 1, 2020 09:04
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