Static Sites with Sphinx and Markdown Transcripts
Lecture: Clean up
Login or purchase this course to watch this video and the rest of the course contents.
0:01 We made a lot of progress so far in the setup we created a Python project
0:07 installed some dependencies. Built a sphinx site using the scaffold added Markdown support,
0:13 have a live reload server. Before we make any more progress, let's do a little bit of cleanup and move some of the auto generated craft out
0:23 of the way. And also switch our index file from restructured text to markdown. Now, start in the sphinx configuration file conf.py.
0:33 It's got a lot of these comments with all the possible things that you could put into Sphinx configuration file commented out.
0:41 We will remove all that and instead, let's just have a small portion that includes the settings that we're actually using. There.
0:52 That's a lot cleaner. Now, we'll go over to the 'index.rst'. What we really want is something that's a markdown. So let's rename it to 'index.md'.
1:04 And then for the contents of this file that's converted over to markdown,
1:12 let's have the title be something about schlock chain and then we're going to replace the
1:17 toc tree. That was a restructured text directive with the MyST. Markdown variation of this. We'll see a lot more about how directives look and markdown
1:31 in subsequent sections. But for now we have changed our site to being 100% markdown.