astropy / astropy/sphinx-astropy

Tie intersphinx inventory locations to versions being installed

Open
#15 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
7
Forks
19
Avg merge
5h 41m
Merged PRs (30d)
1

Description

It may be rather useful is we would tie the location of the intersphinx inventories to the version of the packages we build the docs with. E.g. currently the docs build for astropy core is failing due to some unresolvable links, but the docs otherwise builds perfectly: https://github.com/astropy/astropy/issues/6695

The failures are due to some issues with the intersphinx of the brand new 2.1 of matplotlib. While for the docs we still use the 2.0.2 version. I foresee that similar issues could emerge later, too so it would be nice to link to actually resolve the links to the version we build the docs with.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the intersphinx inventory configuration used by the documentation build and compare it with the package versions installed for the docs. Check how matplotlib 2.0.2 and other dependency versions are represented in the inventory URLs. Done means links resolve against inventories matching the versions used to build the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.