[DOC] Bugged Links

[henrydingliu]

Are you on the latest chainladder version?

• Yes, this bug occurs on the latest version.

Describe the bug in words

A few links on the doc site appears to be bugging.

How can the bug be reproduced?

/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/getting_started/install.md:27: WARNING: 'myst' cross-reference target not found: 'contributing' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.GridSearch:39: WARNING: term not in glossary: 'n_jobs'
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline:4: WARNING: undefined label: 'pipeline_docs'

/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.fit:32: WARNING: undefined label: 'metadata_routing'
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.fit_predict:34: WARNING: undefined label: 'metadata_routing'
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.predict:30: WARNING: undefined label: 'metadata_routing'
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/voting.py:docstring of chainladder.workflow.voting.VotingChainladder:9: WARNING: undefined label: 'voting'
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540023: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540026: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540030: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:620011: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:12: WARNING: more than one target found for 'myst' cross-reference triangle: could be :std:ref:Triangles or :std:doc:Triangles [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:22: WARNING: more than one target found for 'myst' cross-reference triangle: could be :std:ref:Triangle or :std:doc:Triangle [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:29: WARNING: more than one target found for 'myst' cross-reference development: could be :std:doc:Development or :py:mod:chainladder.development [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:45: WARNING: more than one target found for 'myst' cross-reference tails: could be :std:doc:Tail Estimation or :py:mod:chainladder.tails [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:61: WARNING: more than one target found for 'myst' cross-reference methods: could be :std:doc:IBNR Models or :py:mod:chainladder.methods [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:79: WARNING: more than one target found for 'myst' cross-reference adjustments: could be :std:doc:Adjustments or :py:mod:chainladder.adjustments [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/index.md:97: WARNING: more than one target found for 'myst' cross-reference workflow: could be :std:doc:Workflow or :py:mod:chainladder.workflow [myst.xref_ambiguous]

from here

What is the expected behavior?

no warnings

Would you be willing to contribute this ticket?

• Yes, absolutely!
• Yes, but I would like some help.
• No.

[salexanian]

Hi @henrydingliu I would be happy to assist with this if you think it is suitable. If so, please let me know.

[henrydingliu]

we are a little backed up right now. the fix to this issue can't be validated on main until #1091 is in. you are more than welcome to work on it by branching off #1091.

[salexanian]

we are a little backed up right now. the fix to this issue can't be validated on main until #1091 is in. you are more than welcome to work on it by branching off #1091.

Thank you @henrydingliu - I will comply.

[salexanian]

@henrydingliu I took your advice and branched off #1091, but am listing my fixes here so I don't clutter the main issue. I will keep editing this comment as I complete the fixes so you can determine if there is a problem with any of my fixes:

Issue 1:

/home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/getting_started/install.md:27: WARNING: 'myst' cross-reference target not found: 'contributing' [myst.xref_missing]

Improper relative path. Fixed by changing please refer to [Contributing](contributing) in line 27 of install.md to please refer to [Contributing](../library/contributing).

Issue 2: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.GridSearch:39: WARNING: term not in glossary: 'n_jobs'

This problem was due to two issues - n_jobs was missing from the glossary.md file, and the lack of the Sphinx 'glossary' directive in glossary.md. I rectified this by: 1) adding the glossary directive to the glossary.md file and 2) amending the docstring for n_jobs by reducing it to the first descriptive sentence in the docstring, and then moving the more detailed remainder of the docstring to the glossary.md file in a new n_jobs entry.

Issue 3: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline:4: WARNING: undefined label: 'pipeline_docs'

This error was due to a broken reference. After finding the proper reference in the code, I modified line 164 of gridsearch.py to read Read more in the :ref:User Guide <workflow:pipeline>

Issue 4: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.fit:32: WARNING: undefined label: 'metadata_routing'

This error was due to an inability for the docstring to import the metadata_routing label from the sklearn library due to a failure to load intersphinx properly. I fixed this by adding new line 40 to _config.yml as follows - sphinx.ext.intersphinx and by adding the new lines 50-53 as follows to the same file:

      sklearn:
        - https://scikit-learn.org/stable/
        - null

Issue 5 and 6: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.fit_predict:34: WARNING: undefined label: 'metadata_routing' /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/gridsearch.py:docstring of chainladder.workflow.gridsearch.Pipeline.predict:30: WARNING: undefined label: 'metadata_routing'

Solved by the solution to Issue 4 above.

Issue 7: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/envs/main/lib/python3.11/site-packages/chainladder/workflow/voting.py:docstring of chainladder.workflow.voting.VotingChainladder:9: WARNING: undefined label: 'voting'

Fixed by amending line 165 of voting.py to read: Read more in the :ref:User Guide <workflow:votingchainladder>. (the reference within the chevrons was wrong).

Issue 8: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540023: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]

Fixed by correcting path from modules/generated/chainladder.MunichAdjustment to ../library/generated/chainladder.MunichAdjustment in development.ipynb. Also fixed reference to BerquistSherman to add a link like for Munich (housekeeping change).

Issues 9-11: /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540026: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing] /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:540030: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing] /home/docs/checkouts/readthedocs.org/user_builds/chainladder-python/checkouts/main/docs/user_guide/development.ipynb:620011: WARNING: 'myst' cross-reference target not found: 'modules/generated/chainladder.MunichAdjustment' [myst.xref_missing]

Solved by solution to issue 8 above.

[henrydingliu]

don't worry about clutter. just put in all your fixes off of #1091, and raise a new PR into main. as soon as #1091 is merged, you can update the PR with the latest main.

[salexanian]

don't worry about clutter. just put in all your fixes off of #1091, and raise a new PR into main. as soon as #1091 is merged, you can update the PR with the latest main.

That sounds good, @henrydingliu . I have just completed all of the fixes and the warnings should all be gone. I will summarize in a PR as directed.