lornajane/Sphinx-Devportal-Resources.md

Last active October 4, 2021 10:16

Star (1) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/lornajane/1e94ee4747db9ef2d419d269a41d837d.js"></script>
Save lornajane/1e94ee4747db9ef2d419d269a41d837d to your computer and use it in GitHub Desktop.

Download ZIP

List of resources for Sphinx used by Aiven's Developer Portal

Raw

Sphinx-Devportal-Resources.md

Resources for Sphinx as used on Aiven DevPortal

Site: https://developer.aiven.io/ Repo: https://github.com/aiven/devportal

Reading list:

Sphinx homepage https://www.sphinx-doc.org/en/master/
Furo theme https://github.com/pradyunsg/furo
Vale https://github.com/errata-ai/vale and its GitHub Action https://github.com/errata-ai/vale-action
External TOC plugin https://github.com/executablebooks/sphinx-external-toc
Netlify and Sphinx tutorial https://hangar.tech/posts/deploying-sphinx-to-netlify/
Netlify deploy previews https://docs.netlify.com/site-deploys/deploy-previews/
Diataxis https://diataxis.fr/
Plugins https://jareddillard.com/blog/common-ways-to-customize-sphinx-themes.html (a good number of my favourites were made by Jared, thanks!)
https://github.com/mgaitan/sphinxcontrib-mermaid Mermaid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment