Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve Sphinx doc warnings #648

Open
jsstevenson opened this issue Apr 3, 2025 · 0 comments
Open

Resolve Sphinx doc warnings #648

jsstevenson opened this issue Apr 3, 2025 · 0 comments

Comments

@jsstevenson
Copy link
Contributor

Broadly: I think it's good to stay on top of these, because the warnings are often informative/indicative of an unintended problem, but they're easy to miss if you're letting too much stuff hang out unresolved.

I've made two PRs to fix some of them. Here's what's left:

/Users/jss009/code/vrs/docs/source/concepts/LocationAndReference/SequenceLocation.rst:90: WARNING: TODO entry found: Describe and add a ref to an intronic variant profile
/Users/jss009/code/vrs/docs/source/def/gks-core/date.rst: WARNING: document isn't included in any toctree
/Users/jss009/code/vrs/docs/source/def/gks-core/datetime.rst: WARNING: document isn't included in any toctree
/Users/jss009/code/vrs/docs/source/appendices/maturity_model.rst:78: WARNING: undefined label: 'development-process'
/Users/jss009/code/vrs/docs/source/concepts/SequenceExpression/LiteralSequenceExpression.rst:6: WARNING: undefined label: 'sequence'
/Users/jss009/code/vrs/docs/source/def/vrs/ReferenceLengthExpression.rst:84: WARNING: undefined label: 'sequence'
/Users/jss009/code/vrs/docs/source/def/vrs/SequenceExpression.rst:7: WARNING: undefined label: 'sequence'
/Users/jss009/code/vrs/docs/source/conventions/computed_identifiers.rst:26: WARNING: undefined label: 'should-normalize'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:20: WARNING: undefined label: 'state'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:38: WARNING: undefined label: 'inter-residue-coordinates-design'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:38: WARNING: undefined label: 'inter-residue-coordinates-design'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:206: WARNING: undefined label: 'future-plans'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:211: WARNING: undefined label: 'implementations'
/Users/jss009/code/vrs/docs/source/conventions/example.rst:214: WARNING: undefined label: 'associating_annotations'
/Users/jss009/code/vrs/docs/source/conventions/required_data.rst:87: WARNING: undefined label: 'impl-vrs-python'
/Users/jss009/code/vrs/docs/source/def/vrs/ReferenceLengthExpression.rst:84: WARNING: undefined label: 'sequence'
/Users/jss009/code/vrs/docs/source/def/vrs/SequenceExpression.rst:7: WARNING: undefined label: 'sequence'

I'd advise removal of the hanging refs unless there is a genuine intention to circle back to them (I think the TODO is fine and keeping a few items in without putting them in the toctree is fine as a temporary measure).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant