astropy / astropy/sphinx-astropy

Make intersphinx linking work with local builds without internet

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

Description

Currently building the docs is not really feasible without an internet connection as the missing intersphinxes generates hundreds of warnings. Make it possible (if astropy-data is available locally) to build the docs without having those warnings. E.g. `local/python3_local_links` is being picked up properly as it should, but not the rest.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the documentation build configuration and trace how intersphinx locations are resolved, comparing the working local/python3_local_links entry with the other links when astropy-data is available locally. Done means an offline local build no longer emits the missing-intersphinx warnings while the existing local link continues to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, 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.