Update readme based on internal redesign and use markdown#448
Merged
Conversation
frederikprijck
commented
Oct 18, 2022
|
|
||
| <div> | ||
| 📚 <a href="#documentation">Documentation</a> - 🚀 <a href="#getting-started">Getting started</a> - 💻 <a href="#api-reference">API reference</a> - 💬 <a href="#feedback">Feedback</a> | ||
| </div> |
Member
Author
There was a problem hiding this comment.
Needed to use HTML here, as well as actual emoji's rather than github's :book:, to ensure it renders as expected on our generated documentation.
Member
Author
|
Running the docs locally:
|
1 task
ewanharris
requested changes
Oct 25, 2022
ewanharris
approved these changes
Oct 25, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR moves the readme from using
reStructuredTextto markdown, to make it easier to integrate our rebranded footer, as well as to align the readme with the other SDKs, who all use markdown.The navigation is added to the README.md file to ensure it also works on the generated documentation using
Sphinxthroughreadthedocs. The logo's are also added twice, once for the readme in github and once for the docs site.Added an
EXAMPLES.mdfile, and moved a couple of examples from the readme into that file.It also configures
setuptoolsto use markdown, to ensure our markdown is used when published to pypi.Also removes the Indices and tables rendered at the bottom of the docs, see : https://auth0-python.readthedocs.io/en/latest/. They gave some rendering issues with the markdown now, making the build fail. As the links didnt look like to be very useful, I dropped them. Let me know if they should be readded.
Checklist