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

Read the docs requirements update #548

Merged
merged 6 commits into from
Aug 7, 2023
Merged

Read the docs requirements update #548

merged 6 commits into from
Aug 7, 2023

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented Aug 7, 2023

Summary of changes

Read the Docs sent out an email stating the auto-install of certain packages will be removed Aug 29th, 2023. They outlined to have a requirements.txt file within the docs folder. I took the packages they recommend having in there and matched the versions to what is being used in PyNWB.

Checklist

For all schema changes:

  • Add release notes for the PR to docs/format/source/format_release_notes.rst.

If this is the first schema change after a schema release (i.e., the version string in core/nwb.namespace.yaml does not
end in "-alpha"), then:

  • Update the version string in core/nwb.namespace.yaml and core/nwb.file.yaml to the next major/minor/patch
    version with the suffix "-alpha". For example, if the current version is 2.4.0 and this is a minor change, then the
    new version string should be "2.5.0-alpha".
  • Update the value of the version variable in docs/format/source/conf.py to the next version without the
    suffix "-alpha", e.g., "2.5.0".
  • Update the value of the release variable in docs/format/source/conf.py to the next version with the suffix
    "-alpha", e.g., "2.5.0-alpha".
  • Add a new section in the release notes docs/format/source/format_release_notes.rst for the new version
    with the date "Upcoming" in parentheses.

@mavaylon1 mavaylon1 self-assigned this Aug 7, 2023
@mavaylon1 mavaylon1 changed the title Read the docs requirements depreication Read the docs requirements update Aug 7, 2023
@mavaylon1 mavaylon1 marked this pull request as draft August 7, 2023 14:29
@mavaylon1 mavaylon1 marked this pull request as ready for review August 7, 2023 14:39
@mavaylon1 mavaylon1 requested a review from oruebel August 7, 2023 14:39
@oruebel
Copy link
Contributor

oruebel commented Aug 7, 2023

Thanks @mavaylon1 for handling this issue

@mavaylon1 mavaylon1 merged commit 4ebeb86 into dev Aug 7, 2023
3 checks passed
@rly rly deleted the req_docs branch August 7, 2023 17:49
rly added a commit that referenced this pull request Aug 7, 2023
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