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

explicit configuration file per https://about.readthedocs.com/blog/20… #681

Merged
merged 2 commits into from
Jan 20, 2025

Conversation

glyph
Copy link
Member

@glyph glyph commented Jan 19, 2025

…24/12/deprecate-config-files-without-sphinx-or-mkdocs-config/

Description

Fixes #680

Checklist

  • Make sure changes are covered by existing or new tests.
  • For at least one Python version, make sure test pass on your local environment.
  • Create a file in src/towncrier/newsfragments/. Briefly describe your
    changes, with information useful to end users. Your change will be included in the public release notes.
  • Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
  • Ensure docs/tutorial.rst is still up-to-date.
  • If you add new CLI arguments (or change the meaning of existing ones), make sure docs/cli.rst reflects those changes.
  • If you add new configuration options (or change the meaning of existing ones), make sure docs/configuration.rst reflects those changes.

@glyph glyph requested a review from a team as a code owner January 19, 2025 23:00
Copy link
Member

@cyli cyli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@glyph glyph merged commit 0b7deda into trunk Jan 20, 2025
16 checks passed
@glyph glyph deleted the readthedocs-configuration branch January 20, 2025 03:40
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.

explicit configuration file specification for readthedocs
2 participants