Static Sites with Sphinx and Markdown
Offered By: PyCon US via YouTube
Course Description
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
Related Courses
Reproducible ResearchJohns Hopkins University via Coursera Writing READMEs
Udacity مجموعة أدوات عالم البيانات
Johns Hopkins University via Coursera Data Science Tools
IBM via edX Recherche reproductible : principes méthodologiques pour une science transparente
Inria (French Institute for Research in Computer Science and Automation) via France Université Numerique