Publish readmes from edx-platform

[nedbat]

To document djangoapps in edx-platform, we want to write READMEs and have them published to readthedocs.

Acceptance criteria for this ticket:

1. • Work with tCRIL to get an RTD instance stood up that can render arbitrary documentation within edx-platform
2. • Identify a few useful docs to share out & clean up if needed (there are plenty of rst in there but idk if they render weird or are well-formed)

Next Steps / Nice to have:

• Can we group deprecated django apps together somehow and hide them from the main index?
• Can we link to maintainers for a django app?
• Can we link to docs for related services? (e.g. there is a credentials django app in edx-platform that just services Credentials and we should have a pattern for documenting that where we link to the Credentials RTD.)

[hurtstotouchfire]

We recently updated docs here: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/user_api/README.rst So this is one that I'd like to make more visible.

[hurtstotouchfire]

@feanil I updated the description here and added some nice to have / question items at the end there.

[feanil]

Cool, @nedbat can you add me as an assignee so I have this on my list. Some of the recent API related work has brought us closer to getting this over the line.

Related Issue: https://github.com/openedx/edx-platform/issues/32610

[e0d]

@feanil any updates on this for tomorrow?

[feanil]

The consolidation for the sphinx projects in edx-platform should un-block this but I have not yet had time to work on this specifically. Though we are now publishing the docstrings.

[nedbat]

Feanil is handing this to the Aximprovements team.

[feanil]

FYI the ticket tracking this work in edx-platform is https://github.com/openedx/edx-platform/issues/33047