Skip to content

Resolve Sphinx doc warnings #648

@jsstevenson

Description

@jsstevenson

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions