Sphinx Documentation

Extensions and Themes

MyST Syntax

  • add a link to a locale PDF or other file - source

{download}`text <_static/reference.pdf>`

May.la Installation

  • create repo on GitHub and clone it

  • chane into the repo directory

  • run sphinx-quickstart - say yes here:

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]:
html_theme_options = {
    "prev_next_buttons_location": None,


  • convert reStructuredText to Markdown: pandoc -s -t commonmark -o <target>.md <source>.rst