Links and References

Authors:

Brad Stancel

Created:

01/08/2020

Modified:

09/19/2025

List of Useful Most Helpful Links

• Great Cheatsheets

  • https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst

  • https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#what-are-directives

• ReSTructured Text Primer (basically a Sphinx CheatSheet)

  • http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

• DocUtils Reference Site

  • https://docutils.sourceforge.io/docs/user/rst/quickref.html

• Ref Links (Best Internal Linking Method)

  • http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-doc

• Linking to External Sources (great info)

  • https://rackerlabs.github.io/docs-rackspace/tools/use-extlink-library.html

  • http://code.nabla.net/doc/sphinx/api/sphinx/ext/sphinx.ext.extlinks.html

  • http://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html

• Link Substitutions

  • https://stackoverflow.com/questions/48070954/restructuredtext-how-to-include-space-in-a-hyperlink-anchor

• InterSphinx

  • https://alnoki.readthedocs.io/en/latest/dev-guide/procedures/sphinx.html#using-intersphinx

• Links External and Internal

  • https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html

• Warnings and Notes

  • https://sublime-and-sphinx-guide.readthedocs.io/en/latest/notes_warnings.html

• Code Examples

  • https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/directives.html#showing-code-examples

• Great Sites for Setup of Tools, etc.

  • https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html

  • https://docs.restructuredtext.net/articles/configuration.html

  • https://docs.restructuredtext.net/articles/thirdparties.html

• Displaying Videos

  • https://github.com/divi255/sphinxcontrib.youtube (This one works with Python3)

  • https://github.com/sphinx-contrib/youtube (Original one that only works with Python2)

• Online ReSTructured Text Editors

  • http://rst.ninjs.org/

• Building custom documentation workflows with Sphinx

  • https://opensource.com/article/18/11/building-custom-workflows-sphinx

• Write the Docs

  • https://github.com/writethedocs/www

  • http://www.writethedocs.org/

• GitBook - Cool looking SaaS offering that uses Markdown instead of Rst

  • https://docs.gitbook.com/

• Creating Sphinx Roles / “Recipes”

  • https://github.com/ofosos/sphinxrecipes

• https://patchwork.kernel.org/patch/9278407/

• Sphinx Directtives

• sphinx-build command

• Sphinx Builders

• Docutils - rst2pdf options

• Sphinx docs: Remove blank pages from generated PDFs?

• Sphinx Themes - https://github.com/executablebooks/sphinx-book-theme