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 a Sphinx conf.py configuration file to documentation #590

Closed
pashagolub opened this issue Jul 11, 2023 · 0 comments · Fixed by #591
Closed

Add a Sphinx conf.py configuration file to documentation #590

pashagolub opened this issue Jul 11, 2023 · 0 comments · Fixed by #591
Assignees
Labels
🐞 bug Something isn't working 📖 documentation Good for newcomers

Comments

@pashagolub
Copy link
Collaborator

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:
pg-timetable
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.pyMkdocs example mkdocs.yml
Keep documenting,
Read the Docs

@pashagolub pashagolub changed the title Add a Sphinx 'conf.py` configuration file to documentation Add a Sphinx conf.py configuration file to documentation Jul 11, 2023
@pashagolub pashagolub added 🐞 bug Something isn't working 📖 documentation Good for newcomers labels Jul 11, 2023
@pashagolub pashagolub self-assigned this Jul 11, 2023
@pashagolub pashagolub linked a pull request Jul 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐞 bug Something isn't working 📖 documentation Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant