Strategy for Including Documentation next to Code in edx-platform

[robrap]

The edx-platform has a lot of documentation in RST files that live close to the code they are documenting. For example there are a variety of how_tos in edx-platform that are not in the published docs.

Use https://github.com/openedx/edx-platform?search=1 to search for how_tos.

We want to be able to include these docs into the published edx-platform documentation.

Tasks

• Investigate how we would do this with Sphinx and add one or more proposals to this ticket.
• Get the proposals reviewed and agree on one to implement.
• Create a new ticket with the details of the implementation we want to go with.

Outstanding Questions

• Do we want to write an ADR for this? Where would it live?

Acceptance Criteria

• We have a ticket and maybe a prototype for how we might include RST docs outside the docs/ folder into a sphinx project.

[thezaeemaanwar]

Proposal: https://docs.google.com/document/d/19QPUcQCV7z9nJ9KHUhnOEetLMOfWDrEGBRi8dwNKdOE/edit?usp=sharing

[thezaeemaanwar]

Implementation Ticket: #33950