Closed pwalczysko closed 1 year ago
Why not use the same formatting than in the other pages e.g. https://github.com/ome/omero-guide-introduction/blob/master/docs/data-management.rst?
Why not use the same formatting than in the other pages e.g. https://github.com/ome/omero-guide-introduction/blob/master/docs/data-management.rst?
On readthedocs it does not look anything like on the github link you are using, meaning the github rendering is deceptive, the markdown interpretation is different :
Github:
The same page in Readthedocs (https://omero-guides.readthedocs.io/projects/introduction/en/latest/data-management.html)
thank you @jburel - I will merge this - I think we need to see how it really would look like on the latest
. The doubt I have is this: Even when i have built this doc locally with the sphinx theme https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html, I am not in full match of what the GA is doing here.
Compare GA build here https://omero-guides--25.org.readthedocs.build/projects/introduction/en/25/annotate.html (much better than previously, but not matching the local build)
the local build (I think this matches what you showed me on your machine locally, but it does not match the build at https://omero-guides--25.org.readthedocs.build/projects/introduction/en/25/annotate.html) - I think we both would prefer this look below
Noticed during the prep of the upcoming outreach event https://docs.google.com/document/d/1NAWJjNU-La9tk9cO6nnMTRREOZ4bi0S39Hkjj6PeYuQ/edit#
The description of the https://omero-guides.readthedocs.io/projects/introduction/en/latest/annotate.html is barely readable because of the formatting issues (the bullet points are not respected).
This PR suggests an Line block approach. See build at https://omero-guides--25.org.readthedocs.build/projects/introduction/en/25/annotate.html - much more readable imho. If we are happy with this formatting, I can propagate it to other guides.
Before:
After: