sphinx-doc/sphinx

Please generate devhelp index format v2

Open

#4,890 opened on Apr 23, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (1,985 forks)batch import
builderhelp wanted

Repository metrics

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

Description

Problem

Sphinx in devhelp mode generates index file format v1, which is deprecated

Procedure to reproduce the problem

Error logs / results

Apr 23 11:20:24 espresso devhelp[32481]: The file 'file:///usr/share/devhelp/books/python-mpd2/python-mpd2.devhelp.gz' uses the Devhelp index file format version 1, which is deprecated. A future version of Devhelp may remove the support for the format version 1. The index file should be ported to the Devhelp index file format version 2.

Environment info

  • OS: Debian GNU/Linux unstable (development branch) with GNOME 3.28
  • Python version: python3.6 3.6.5-3 from Debian
  • Sphinx version: 1.7.2-4 from Debian
  • devhelp 3.28.1-1 from Debian

Contributor guide

Research direction
Inspect the devhelp writer in Sphinx's source code, understand the current format v1, and implement support for format v2 according to the Devhelp specification.
Tech stack
python
Domain
documentation
Issue type
Feature
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
PythonGitSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75