jazzband / django-oauth-toolkit

OAuth2 goodies for the Djangonauts!
https://django-oauth-toolkit.readthedocs.io
Other
3.06k stars 777 forks source link

docs: clean up and improve documentation #1401

Closed shuuji3 closed 4 months ago

shuuji3 commented 4 months ago

Description of the Change

Hello, I've read through all the documentation pages and refactored them to have consistent markups. Also, fixed several errors during the proofreading.

All changes are documentation clean up so I combined the same kind of changes into each commit, but if you feel this PR contains too many changes, I can split this PR into small chunks. 🙂

Checklist

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.56%. Comparing base (817eb40) to head (90bddf9).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1401 +/- ## ======================================= Coverage 97.56% 97.56% ======================================= Files 32 32 Lines 2132 2132 ======================================= Hits 2080 2080 Misses 52 52 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

shuuji3 commented 4 months ago

Thanks for merging!

Actually, switching single backtick to double ones is my initial motivation to make this PR. While they are almost the same in source code text, it is rendered as italic and code-block rspectively in the Read the Docs website (in HTML, <cite>italic</cite> and <code>code-block</code>).

I think the later presentation improves the readability much better (also <cite> is not appropriate as an HTML tag).

Before

Screenshot from 2024-02-28 11-29-30 https://django-oauth-toolkit.readthedocs.io/en/stable/rest-framework/getting_started.html

After

Screenshot from 2024-02-28 11-29-25 https://django-oauth-toolkit.readthedocs.io/en/latest/rest-framework/getting_started.html#step-1-minimal-setup