Upgrade Sphinx to 1.7
- Dominant language
- Python
- Stars
- 58
- Forks
- 160
- Avg merge
- 5d 11h
- Merged PRs (30d)
- 12
Description
They finally solved [the line number issue with rst_prolog](https://github.com/sphinx-doc/sphinx/issues/2617). (woohoo)
This will probably require some adjustment to some of our custom code. It seems we are importing `/sphinx/util/compat`, which has been deprecated. See the warning that is output when you run a build currently:
```
site-packages/sphinx/util/compat.py:40: RemovedInSphinx17Warning: sphinx.util.compat.Directive is deprecated and will be removed in Sphinx 1.7, please use docutils' instead.
RemovedInSphinx17Warning)
```
Contributor guide
Research direction
Start by running the current Sphinx documentation build and capture the deprecation warning for sphinx/util/compat. Locate the custom code importing the deprecated compatibility module, then upgrade Sphinx to 1.7 and adjust that code as needed. Done means the build completes without the RemovedInSphinx17Warning and the rst_prolog line-number issue is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100