astropy / astropy/astroquery

BUG DOC: module docs in solarsystem is broken for some modules

Open
#3,021 0 comments 0 reactions 0 assignees View on GitHub
bug Documentation solarsystem
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

solarsystem is just an alias namespace for a couple of modules, e.g `imcee`, but unfortunately navigating to the module from the solarsystem module is broken, and instead we rendered there an empty docs page.

E.g. https://astroquery.readthedocs.io/en/latest/solarsystem/imcce/imcce.html which should instead point back to https://astroquery.readthedocs.io/en/latest/imcce/imcce.html

Contributor guide

Open the contributing guide

Research direction

Start with the documentation generation or navigation entry point responsible for the solarsystem alias, then compare the broken solarsystem/imcce/imcce.html URL with the canonical imcce/imcce.html page. Done means navigating through solarsystem to an aliased module reaches the canonical documentation instead of an empty page.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.