Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

YouTube

Static Sites with Sphinx and Markdown

PyCon US via YouTube

Overview

Google, IBM & Meta Certificates – 40% Off
One Coursera Plus subscription covers most Professional Certificates on Coursera.
Unlock All Certificates
This talk introduces Sphinx as a static site generator and shows how to use MyST for Markdown authoring. It demonstrates Sphinx’s linking and cross-referencing features and briefly covers customization.

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

Reviews

Start your review of Static Sites with Sphinx and Markdown

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.