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

Add explicit ReadTheDocs configuration. #203

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

bdice
Copy link
Member

@bdice bdice commented Dec 23, 2024

Description

ReadTheDocs shared the following announcement:

We are announcing the deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file. After January 20, 2025, Read the Docs will require explicit configuration for all Sphinx and MkDocs projects.

This adds the explicit key required by the above.

Checklist:

@bdice bdice requested review from a team as code owners December 23, 2024 21:24
@bdice bdice requested review from vyasr and iblanco11981870 and removed request for a team December 23, 2024 21:24
@bdice
Copy link
Member Author

bdice commented Dec 23, 2024

I will admin-merge this because CI is passing and this is similar to the change in glotzerlab/gsd#410.

@bdice bdice merged commit d1cf5d9 into main Dec 23, 2024
2 checks passed
@bdice bdice deleted the add-explicit-readthedocs-configuration branch December 23, 2024 21:28
@joaander
Copy link
Member

joaander commented Jan 6, 2025

@bdice I failed to get the notification because I am not a maintainer of signac-docs on readthedocs. Could you invite me?

@bdice
Copy link
Member Author

bdice commented Jan 7, 2025

@joaander I think you're already there? The signac repo maps to signac-core on ReadTheDocs, and the signac-docs repo maps to signac on ReadTheDocs. I see all 5 signac-related ReadTheDocs projects (signac, signac-core, signac-flow, signac-dashboard, and synced_collections) on your user profile: https://app.readthedocs.org/profiles/joaander/?page=2

Let me know if something needs changed.

@joaander
Copy link
Member

joaander commented Jan 7, 2025

Thanks for clarifying how the repository names map to readthedocs projects.

@bdice
Copy link
Member Author

bdice commented Jan 7, 2025

No problem. We chose that mapping so that the top-level project mapped onto https://docs.signac.io/en/latest/ was named "signac" for the framework as a whole.

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