MetOffice / MetOffice/ANTS

Sphinx documentation warning in later version

Open
#76 1 comment 0 reactions 0 assignees View on GitHub
📚 documentation
Dominant language
Python
Stars
7
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
5

Description

When building documentation using a later than curent version of sphinx (current is 7.2.6, later is 7.4.7) There is a warning that will need to be resovled:

```
${the/run/directory/}share/fcm_make_ants/build/docs/source/merge.rst:12: WARNING: underfined label: 'ancile_fill_n_merge.py'
make: *** [html] Error 1
```

I think this is because the page that is being linked to is generated automatically and therefore doesn't have a corresponding label.

Contributor guide

Open the contributing guide

Research direction

Start with share/fcm_make_ants/build/docs/source/merge.rst at line 12 and reproduce the documentation build using Sphinx 7.4.7. Trace the link to ancile_fill_n_merge.py and determine how the generated page is referenced; done means the build completes without the undefined-label warning.

Written by the indexing model from the issue text.

Assessment

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