FEDIDEVS

Hello #PyConUS! It's time for @kattni's talk: "Switching from Sphinx to Markdown"

Come join us in Ballroom B

Hey! Are you at #PyConUS and interested in #CivicTech? Come join me and @civicband and chat about how you can help where you live with #python

3pm in room 201b

The fire under my behind to get a Trusted Publishing setup for something not GitHub/gitlab based continues to grow.

We must remove every barrier to getting off github.

#PyConUS

@kattni is a Core Developer on @beeware, as well as being the Chair of @pyohio

She led the documentation migration project for #BeeWare

#PyConUS

“Reviews used to be a conversation. That created maintainers”

Pablo Galindo Salgado at #PyConUS

The @ThePSF should put on Python.org that you can get #python for “$9.99 (just kidding)” and see if donations go up 😂

#PyConUS

A brief note about the future of MkDocs:

- MkDocs 1.0 not maintained
- MkDocs 2.0: not backwards compatible
- ProperDocs: fork to preserve 1.0
- Zensical: drop in replacement
- General migration process is the same

#PyConUS

rst and sphinx have been used in #Python for 20 years! It has a ton of community support, and BeeWare's docs were originally in rst using Sphinx

So what about markdown?

#PyConUs

Markdown's biggest issue tends to be the disagreements around what the "standard" flavor of Markdown is. Gruber has refused to release a standard, creating a wide collection of competing flavors.

That said, there's still a rough consensus.

#PyConUS

Linting and checking on the generated Markdown was also critical. The pipeline checks for spelling, link validity, and more.

BeeWare now also has a comprehensive suite of docs tools, including sandboxing, single source for deps, unified theme, and shared common content.

Now, with the migration prepared, the real migration could start!

#PyConUS