sphinx-doc / sphinx-doc/sphinx

Incomplete documentation for env_version

Open
#12,237 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted internals:environment type:docs
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

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

How to Reproduce

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the extension metadata and domain API pages, then compare the TODO and recipe tutorials with sphinx/domains/init.py. Identify which unchecked documentation points remain after the referenced fixes, update the relevant documentation and Domain docstring, and verify the examples explain env_version and data_version consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.