sphinx-doc/sphinx

Optional 'types' argument of Sphinx.add_config_value() is not documented

Open

#8,054 opened on Aug 4, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
help wantedtype:bugtype:docs

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

See https://www.sphinx-doc.org/en/master/extdev/appapi.html?highlight=add_config_value#sphinx.application.Sphinx.add_config_value

Contributor guide

Research direction
Identify the missing documentation for the 'types' argument in 'add config value' and add it to the appropriate documentation page.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80