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: find a way how we can use power of Sphinx to document violations #316

Closed
sobolevn opened this issue Oct 31, 2018 · 0 comments
Closed
Assignees
Labels
documentation Docs related task feature New feature or request
Milestone

Comments

@sobolevn
Copy link
Member

Currently we have two hacks:

  1. error code is explicitly duplicated in the docs
  2. each error template is prefixed by #: so it would appear in the final html

But, I do not like this solution. There must be a better way!

What can be done?

  1. We can try to make error_code and error_template default arguments for all classes
  2. We can try to make a custom directive
  3. We can try to locally configure things we need to show to the user
  4. We can explicitly add these fields to all autoclass lines (I do not like it)
@sobolevn sobolevn added this to the Version 0.5.0 milestone Oct 31, 2018
@sobolevn sobolevn added feature New feature or request documentation Docs related task labels Oct 31, 2018
@sobolevn sobolevn self-assigned this Oct 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs related task feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant