GilbertLabUCSF / ScreenPro2

[This is an archived repository, see the current version in Arc Institute GitHub]
https://github.com/ArcInstitute/ScreenPro2
MIT License
1 stars 1 forks source link

Improve ReadTheDocs format #23

Closed abearab closed 9 months ago

abearab commented 10 months ago
abearab commented 9 months ago

@nick-youngblut:

For the ReadTheDocs function API pages, the args are not formatted correctly (no line wrapping). I used Google formatting for the python function docs; maybe this setting must be specifically set in sphinx? ...or we could use a different format type for function docs.

abearab commented 9 months ago

@nick-youngblut:

I believe that readthedocs can now handle markdown (which is much cleaner than RST), Some docs on parsing markdown with Sphinx: https://www.sphinx-doc.org/en/master/usage/markdown.html

abearab commented 9 months ago

https://chat.openai.com/share/cb8c33c7-d4c1-4e95-870f-78caa9a9b338

abearab commented 9 months ago

moved to https://github.com/ArcInstitute/ScreenPro2/issues/8