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

DOC: Add env_version to "todo" tutorial #12349

Merged
merged 1 commit into from
May 5, 2024
Merged

DOC: Add env_version to "todo" tutorial #12349

merged 1 commit into from
May 5, 2024

Conversation

mgeier
Copy link
Contributor

@mgeier mgeier commented May 5, 2024

Feature or Bugfix

  • Bugfix

Purpose

According to https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata:

If not given, Sphinx considers the extension does not stores any data to environment.

Since the todo extension does store data to the environment, it should also define env_version.

Relates

@mgeier mgeier mentioned this pull request May 5, 2024
Open
7 tasks
chrisjsewell
chrisjsewell approved these changes May 5, 2024
View reviewed changes
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

sounds reasonable 👍

@chrisjsewell chrisjsewell merged commit 13b0fcc into sphinx-doc:master May 5, 2024
7 checks passed
@mgeier mgeier deleted the tutorial-todo-env_version branch May 5, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisjsewell chrisjsewell chrisjsewell approved these changes

Assignees
No one assigned
Labels
type:docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@mgeier @chrisjsewell