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

readme generator generates different output depending on docutils version installed #423

Closed
sbidoul opened this issue Jul 29, 2019 · 3 comments · Fixed by #570
Closed

readme generator generates different output depending on docutils version installed #423

sbidoul opened this issue Jul 29, 2019 · 3 comments · Fixed by #570
Labels

Comments

@sbidoul
Copy link
Member

sbidoul commented Jul 29, 2019

Exemple:

<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />

This is annoying because an accidental docutils upgrade (it is not pinned in maintainer-tools setup.py) can trigger a regenaration of all readme index.html, with the useless republishing of a ton of packages to pypi, and hours of travis builds.

First we should pin docutils to 0.15.1 in maintainer-tools setup.py with a comment explaining why.

This solution will break at some point because inevitably, in the future, that specific version will end up being not installable or too old for some other dependency...

@pedrobaeza
Copy link
Member

Isn't any way (arg or similar) to avoid to stamp that meta tag?

sbidoul added a commit to acsone/maintainer-tools that referenced this issue Jul 29, 2019
sbidoul added a commit to acsone/maintainer-tools that referenced this issue Jul 29, 2019
@sbidoul
Copy link
Member Author

sbidoul commented Jul 29, 2019

Yes we could remove that line. But the whole thing remains very sensitive to small changes in the html output produced by docutils.

That index.html is only there because Odoo SA says they provide better referencing for addons with an html description.

@sbidoul sbidoul added the bug label Jul 29, 2019
@pedrobaeza
Copy link
Member

Yeah, good point about other possible changes due to different versions. Pinning seems a good option. Indeed, the HTML stuff is something very annoying...

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

Successfully merging a pull request may close this issue.

2 participants