Skip to content

Add more cross-listings and a CI test for warnings in docs #622

Closed
@maxrjones

Description

@maxrjones

You should add cross linking for all your dependencies:

I'd also suggest adding cross linking for your optional dependencies

Originally posted by @kylebarron in #615 (comment)

I'd also suggest adding a CI step that ensures your docs build doesn't have any warnings: developmentseed/obstore@ec7dd29/.github/workflows/test-python.yml#L73-L76

This ensures that all links are valid

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions