Explore static site generation using Sphinx and Markdown in this 22-minute PyCon US talk. Learn how to leverage Sphinx, traditionally used for project documentation, for building entire websites. Discover the advantages of MyST, which brings full Markdown support to Sphinx, making it more accessible to those familiar with Markdown syntax. Compare Sphinx's features to other static site generators, including its rich linking capabilities and suitability for creating comprehensive knowledge bases. Follow along as the speaker demonstrates how to enable MyST for Markdown in Sphinx, configure the system, and utilize enhanced Markdown features like admonitions, toctree with options, and cross-referencing. Gain insights into customization options and explore the potential future developments of Sphinx for static site generation.
Overview
Syllabus
Intro
Markdown and Python Easy to do headings, paragraphs, lists
WAIT A SECOND !!!! That's not Markdown...
Static Websites with Sphinx and Markdown
Old Days
Single Page App (SPA)
Meanwhile, for docs
Meanwhile, for sites
What Does Sphinx Do?
Sphinx Site
Install Sphinx S pip install sphinx
Install MyST Spip install myst-parser
Configure Sphinx for MyST extensions - "myst parser", ...
index.rst - index.md
How It Works
Markdown Image ![Alt Text] static/logo.png
Enhanced Markdown Image image static/logo.png :alt: Python Logo
Basic Admonition
Enhanced Admonition
toctree With Options
toctree With YAML
Markdown Link URL [link text]
Markdown Linking [link text] (../path/to/doc)
Without Link Text 014../path/to/doc
Warning on Broken Link
Linking to a Role Targets and Cross-Referencing
Role & No Link Text
Intersphinx
Code Fence With Language
Code Fence Options
literal-include
Lots More To Cover
Plenty to Read
What's the Future?
Taught by
PyCon US
