Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App specific docs are not included in readthedocs documentation #33327

Closed
robrap opened this issue Sep 22, 2023 · 2 comments
Closed

App specific docs are not included in readthedocs documentation #33327

robrap opened this issue Sep 22, 2023 · 2 comments

Comments

@robrap
Copy link
Contributor

robrap commented Sep 22, 2023

Many app specific doc directories, like https://github.com/openedx/edx-platform/tree/98678536d6248755730bd2fafead55d05cf264da/openedx/core/djangoapps/oauth_dispatch/docs, are not published as part of the docs. It would be great if they could be.

See https://github.com/openedx/edx-django-utils/blob/master/docs/monitoring/README.rst for one potential solution.

@robrap
Copy link
Contributor Author

robrap commented Oct 16, 2023

Note that OEP-19 recommends keeping the docs close to the code (e.g. app specific), but doesn't resolve this issue. We may want to update OEP-19. And alternative would be to have /opednedx/edx-platform/docs/oauth_dispatch/how-tos, etc., or some other new folder structure within the top-level docs folder.

@robrap
Copy link
Contributor Author

robrap commented Jun 20, 2024

Closing this ticket. See https://docs.openedx.org/projects/edx-platform/en/latest/references/docs/index.html. A new ticket will be added to help with discoverability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant