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

Remove rst- prefix on CSS classes generated from docutils (all CSS classes in docstrings basically) #452

Open
tristanlatr opened this issue Oct 30, 2021 · 3 comments

Comments

@tristanlatr
Copy link
Contributor

This is a behaviour inherited from epydoc that we don't need I think.

And it adds extra complexity to the starttag() method of the HTMLTranslator:

def starttag(self, node: nodes.Node, tagname: str, suffix: str = '\n', **attributes: Any) -> str:

We don't need it and it makes thing more complicated where it doesn't have to be.

@tristanlatr
Copy link
Contributor Author

This will have as effect to break all custom CSS using the older CSS class names starting by rst-. So I'de suggest we make it clear in the changelog.

@tristanlatr tristanlatr changed the title Remove -rst prefix on CSS classes generated from docutils (all CSS classes in docstrings basically) Remove rst- prefix on CSS classes generated from docutils (all CSS classes in docstrings basically) Nov 18, 2021
@adiroiban
Copy link
Member

Yes. Thanks for the headup.
It's important to have this in the changelog.

I don't know how many users have custom CSS. If it's just for twisted, that is ok.

@tristanlatr
Copy link
Contributor Author

The more I think about this issue the more I believe it should be marked as won’t fix. It’s been like that from the beginning and I don’t have another reason to change that appart « I don’t think we need it ».

I’ll try to run some performance tests to see if that would improve pydoctor… but I really doubt it will be significant.

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