python / python-docs-theme

Sphinx theme for Python documentation
Other
74 stars 58 forks source link

Link to kitchen sink demo in README and convert to Markdown #184

Closed hugovk closed 4 months ago

hugovk commented 4 months ago

https://sphinx-themes.org has sample builds of many Sphinx themes, including this one.

They have a very handy "kitchen sink" to demo all the Sphinx features, so we can easily see things like admonitions, lists, structure and so on.

https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/

Also convert the README to Markdown, we don't need the full complexity of reStructuredText here.