Skip to content

Use Sphinx config to discover directives #1

Open

Description

@JulienPalard

An idea of @jean-abou-samra, see: sphinx-doc/sphinx#10143 (comment)

I like the idea: it should lead to less false positives, which is very important. It could even help spot typos in directive names!

As long as it's still fast to check a single file, so it can be used as a linter in an editor, I don't want rstlint to become slower than make suspicious from cpython, on my machine, for a full cpython/Doc/ check:

  • sphinx-lint takes 5.7s
  • make suspicious takes from 36s to 1m22s (depends on the cache)

Activity

  1. jeanas commented on Feb 3, 2022

    @jeanas
    Contributor

    Not sure if I'll have the time soon, but I'm basically interested in working on this.

  2. LecrisUT commented on Dec 17, 2025

    @LecrisUT

    I wonder that if this is being done, than the speed promise goes out the window. In that case it would be good to offer some other slower but less error-prone interfaces, mainly a sphinx-builder that would pick up the exact sources being used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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