docs: update plugin docs

openedx / edx-django-utils

edX utilities for Django Application development.

https://edx.readthedocs.io/projects/edx-django-utils/en/latest/

Apache License 2.0

26 stars 20 forks source link

docs: update plugin docs #278

Closed robrap closed 1 year ago

robrap commented 1 year ago

Description:

Refactors and updates the plugin README.
Moves part of the README to a new how-to for creating new plugin apps.

Issue:

https://github.com/openedx/edx-django-utils/issues/276

Merge checklist:

[ ] All reviewers approved
[ ] CI build is green
[ ] Changelog record added
[ ] Documentation updated (not only docstrings)
[ ] Commits are squashed

Post merge:

No new version needed. Just doc changes.

robrap commented 1 year ago

Note: I tabbed-in a big section that is meant to move to the how-to, so either move the code or view the diff without whitespace changes to see the recommended changes. This is just to document proposed changes for https://github.com/openedx/edx-django-utils/issues/276, so I'm closing this for now. Feel free to reopen or start a fresh copy off this branch.

rgraber commented 1 year ago

A few bits of cleanup, but otherwise looks good.

The :doc: syntax didn't seem to work, but text <path/to/doc>_ did

timmc-edx commented 1 year ago

The tricky bit is that the .rst links only work on GitHub, whereas the :doc: links only work on Read The Docs (or if you use make docs). I think we should prefer the latter.