Skip to content
This repository has been archived by the owner on Dec 12, 2023. It is now read-only.

Improve ReadTheDocs format #23

Closed
1 of 2 tasks
Tracked by #1
abearab opened this issue Nov 12, 2023 · 4 comments
Closed
1 of 2 tasks
Tracked by #1

Improve ReadTheDocs format #23

abearab opened this issue Nov 12, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@abearab
Copy link
Collaborator

abearab commented Nov 12, 2023

  • Use myst-parser to parse .md files
  • Fix formatting for function comments
@abearab abearab mentioned this issue Nov 12, 2023
12 tasks
@abearab abearab added the documentation Improvements or additions to documentation label Nov 12, 2023
@abearab
Copy link
Collaborator Author

abearab commented Dec 7, 2023

@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
Copy link
Collaborator Author

abearab commented Dec 7, 2023

@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
Copy link
Collaborator Author

abearab commented Dec 9, 2023

@abearab
Copy link
Collaborator Author

abearab commented Dec 11, 2023

moved to ArcInstitute/ScreenPro2#8

@abearab abearab closed this as completed Dec 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant