docs: update documentation according latest standards

[mariajgrimaldi]

Description:
This PR updates the README file according to latest standards, including OEP-55.

Merge deadline:
ASAP

Installation instructions:
Just documentation.

Testing instructions:
Just documentation.

Reviewers:

• @felipemontoya

Merge checklist:

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

Post merge:

• Create a tag
• Check new version is pushed to PyPI after tag-triggered build is
  finished.
• Delete working branch (if not needed anymore)

Author concerns:
how do we set readthedocs documentation?

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi!

As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion.

[mariajgrimaldi]

@feanil: hello! 😄
As I mentioned in the PR concerns, how can we set readthedocs for this repo? (as it was for openedx-events)

[felipemontoya]

I left a few minor comments but they are non-blockers. Overall I think the docs change is great and the repo will be in a way better shape after the PR is merged.

[felipemontoya]

We need to make sure that readthedocs is building. But maybe that can only happen after we merge the PR?

[mariajgrimaldi]

Check Feanil's comment: #49 (comment)

[feanil]

@mariajgrimaldi one of the things on my list for the next week or two is to write the doc that tells maintainers how they can get read the docs setup for their projects 🔁 . It looks like you don't need that to land the readme and changelog changes you have so far but I'll have that written soon and ping you on it so you can try it out here to setup sphinx docs in the way we want to standardize. We can do that as a follow-on task if that works for you?

Update: This is the ticket that will track that work if you want to follow along: openedx/docs.openedx.org#216

[mariajgrimaldi]

@feanil: that works perfectly! Thank you.

[openedx-webhooks]

@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.