sphinx-doc/sphinx

apidoc and autosummary does not support east-asian characters

Open

#3,591 opened on Mar 29, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
extensions:apidocextensions:autosummarygood first issue

Repository metrics

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

Description

refs: https://github.com/sphinx-doc/sphinx/pull/3585#discussion_r108050337

@eric-wieser Please let me know where you found the similar problem in apidoc. I'll take a look

Contributor guide

Research direction
Investigate the referenced PR #3585 and the discussion around east asian character support in Sphinx's apidoc and autosummary modules. Look at the relevant source files in the sphinx/ext/ directory. Check if the issue has been addressed in later commits. Consider encoding issues in the generated output and how to properly handle CJK characters.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonSphinx internalsunicode handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30