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 source sub-dir under docs and bring those file up a level #210

Open
sgibson91 opened this issue Jul 11, 2023 · 0 comments
Open

Remove source sub-dir under docs and bring those file up a level #210

sgibson91 opened this issue Jul 11, 2023 · 0 comments
Assignees

Comments

@sgibson91
Copy link
Member

I got an email from ReadTheDocs about auto-generating docs/conf.py files for projects that don't have them and that this will be sunsetted on Aug 8th (full text below). We do actually have a conf.py file, but I suspect it's one level too low for RTD to automatically find, so we should fix that.

Hello,

Historically Read the Docs has created a docs/conf.py file for Sphinx projects and a mkdocs.yml file for MkDocs projects that don't provide one, to make onboarding easier. This has been confusing a lot our users in different ways and we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don't have one on August 28th. To avoid unexpected behavior or your documentation builds failing, you should add a configuration file to your project by this date.We are sending you this email because you are a maintainer of the following projects that are affected by this removal:jupyterhub-outreachyThe auto-creation of a default configuration file will be completely removed on August 28th. Add a conf.py/mkdocs.yml to your projects before this date to avoid unexpected build failures.You can find a good example of a basic configuration file in our example projects:Sphinx example conf.pyMkdocs example mkdocs.yml
Keep documenting,Read the Docs

Hello,
Historically Read the Docs has created a docs/conf.py file for Sphinx projects and a mkdocs.yml file for MkDocs projects that don't provide one, to make onboarding easier. This has been confusing a lot our users in different ways and we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don't have one on August 28th. To avoid unexpected behavior or your documentation builds failing, you should add a configuration file to your project by this date.

We are sending you this email because you are a maintainer of the following projects that are affected by this removal:

jupyterhub-outreachy
The auto-creation of a default configuration file will be completely removed on August 28th. Add a conf.py/mkdocs.yml to your projects before this date to avoid unexpected build failures.

You can find a good example of a basic configuration file in our example projects:

Sphinx example conf.py
Mkdocs example mkdocs.yml
Keep documenting,
Read the Docs

@sgibson91 sgibson91 self-assigned this Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant