search

twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io
Other
190 stars 51 forks source link

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

Open tristanlatr opened 3 years ago

tristanlatr commented 3 years ago

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:

https://github.com/twisted/pydoctor/blob/bd7bf992432c25c934d9e56e0e4f15553f7216e0/pydoctor/node2stan.py#L125

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

tristanlatr commented 3 years ago

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.

adiroiban commented 3 years ago

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 commented 2 months ago

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.