Skip to content

Add Sphinx correctness checking for our docs to CI #291

@jli

Description

@jli
  • Make sure latest docs build without errors
    • Use -n for nitpicky mode. Generates some warnings about bad links we should fix.
  • Consider checking validity of links? (sphinx-build -b linkcheck docs docs/_build/linkcheck)
    • Sphinx 3.2.0 added checking for local links, which causes a bunch of false positives. Think we can fix by using references instead of links.

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