johannesjh / req2flatpak

Convert Python package requirements to Flatpak build manifests
https://johannesjh.github.io/req2flatpak/
MIT License
19 stars 2 forks source link

docs: fix bullet lists by adding trailing whitespace #57

Closed johannesjh closed 1 year ago

johannesjh commented 1 year ago

I noticed these aren't rendered as bullet lists since they are missing trailing whitespace (for some reason github's renderer doesn't care):

https://github.com/johannesjh/req2flatpak/blob/847406f3afabee316059f3a484466c70651541a8/docs/source/development.rst?plain=1#L29-L33

Originally posted by @real-yfprojects in https://github.com/johannesjh/req2flatpak/issues/55#issuecomment-1512657372

johannesjh commented 1 year ago

Bulleted lists are broken in many (if not all) places in the documentation.

For example, here as screenshots of the README, as rendered by github, correctly rendered with bullets: bulletlists rendered correctly by github

... and the same content rendered by sphinx, broken without bullets: bulletlists broken rendering in sphinx

real-yfprojects commented 1 year ago

Yes its basically everywhere. Adding a trailing line after each bullet point should fix it.

johannesjh commented 1 year ago

Adding newlines between the bullet points did not work.

I found this stackoverflow question: https://stackoverflow.com/q/67542699 The answers suggest that it is a bug in sphinx-rtd-theme