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

[Feature]: how to register your own sphinx-directives? #209

Open
2 tasks done
woutervh opened this issue Jan 29, 2024 · 1 comment
Open
2 tasks done

[Feature]: how to register your own sphinx-directives? #209

woutervh opened this issue Jan 29, 2024 · 1 comment

Comments

@woutervh
Copy link

To Dos

  • I have checked the issues and think that this is not a duplicate.

  • I added a very descriptive title to this issue.

Description

sphinx allows to develop your own directives,
in order to check correctness, we want to have support in the linter instead if ignoring all of the custom directives

Operating System

Linux

Operating System Details

Alma Linux 9.3

Python Version

3.11.6

rstcheck Version

rstcheck==6.2.0 + rstcheck-core==1.2.0

@Cielquan
Copy link
Collaborator

Cielquan commented Mar 3, 2024

As of now, there is unfortunately no way to register your own roles or directives.

I think this would require a much more sophisticated configuration system, where an INI file is not sufficient and would need to be replaced by a python source file which gets loaded (like sphinx does). But unlike sphinx rstcheck has a config hierarchy system within the config auto-detect functionality, which may or may not make problems with python source files for configuration.

If you have a good idea, I am open for discussion and PRs.

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

No branches or pull requests

2 participants