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.

Sign up for GitHub

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

Jump to bottom

Add readthedocs.yaml #551

Open
4 of 10 tasks
rly opened this issue Aug 8, 2023 · 1 comment
Open
4 of 10 tasks

Add readthedocs.yaml #551

rly opened this issue Aug 8, 2023 · 1 comment
Assignees
@mavaylon1
Labels
category: enhancement improvements of code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation

Comments

@rly
Copy link
Contributor

rly commented Aug 8, 2023

From https://blog.readthedocs.com/migrate-configuration-v2/

We are announcing a new requirement for all builds to use our configuration file version 2. This announcement deprecates builds without a configuration file, as well as version 1 of our configuration file.

Read the Docs will start requiring a .readthedocs.yaml configuration file for all projects in order to build documentation successfully. We will stop supporting builds without explicit configuration, because this creates implicit dependencies that users aren’t aware of. We plan to start failing builds not using configuration file version 2 on September 25, 2023.

We need to add a .readthedocs.yaml to all NWB and HDMF-related projects without one in the next two months.

  • hdmf
  • hdmf-common-schema
  • hdmf-schema-language
  • NWB GUIDE
  • NWBInspector
  • nwb-overview
  • nwb-schema
  • nwb-storage
  • PyNWB
  • schema-language

@mavaylon1 can you take care of these? Let me know if you have any permissions issues.
@rly rly added category: enhancement improvements of code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation labels Aug 8, 2023
@mavaylon1
Copy link
Contributor

I'll get on it.

@rly rly mentioned this issue Dec 7, 2023
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mavaylon1 mavaylon1

Labels
category: enhancement improvements of code or code behavior priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rly @mavaylon1