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

Configure (and autodiscover) directives #26

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

AA-Turner
Copy link
Member

Closes #1, closes #25 (if implemented)

This is a proof of concept of configurable directive support and autodiscovery of directives.

Directive names can be listed in the lint table of sphinx.toml or from tools.sphinx.lint in pyproject.toml.

Auto discovery is currently in directivegetter.py -- this would probably need to be refactored into sphinxlint/blah.

I'd welcome thoughts or feedback!

A

@JulienPalard
Copy link
Collaborator

This PR needs love :)

I even have a rebase locally but main diverged further :D

(Writing this just to state I'm not forgetting it.)

@AA-Turner
Copy link
Member Author

@JulienPalard is the feature welcome? Happy to bring it up to date but would welcome design review.

A

@JulienPalard
Copy link
Collaborator

@AA-Turner Yes I think this is a good idea.

@JulienPalard
Copy link
Collaborator

I fixed main so in pytest we see the output (in case it differs from "No problems found.\n"), maybe you want to rebase.

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

Successfully merging this pull request may close these issues.

Configure supported directives Use Sphinx config to discover directives
2 participants