Static Sites with Sphinx and Markdown Transcripts
Lecture: Making a Sphinx site
Login or purchase this course to watch this video and the rest of the course contents.
0:00 We're all set up Sphinxes installed using a requirements.txt file, Time to make a site. Sphinx
0:08 Ships with a site generator command aka scaffold called sphinx-quickstart, which we saw at the end of the previous step.
0:17 It's now in the bin directory of our virtual environment. Let's run and answer some questions and let it generate the beginning of our site.
0:26 I'm in the terminal that has the virtual environment activated so I can start typing 'sphinx quickstart' and it will auto complete.
0:34 I'll pass it no arguments and just hit enter and let it get to work. It's going to ask me some questions.
0:40 I'll accept the defaults on most of these and this is where I want the build directories kind of the output to go and I'll give it a name,
0:49 I'll give it the name of this fictional company Schlock chain. I'll put myself as the author with my email address and then I'll start accepting the
1:00 defaults on a number of these. Sphinx can have multiple languages for output and it's now generated some extra files.
1:09 So if we go take a look in our project tree, it's generated a build directory, which is the output. Um, I generally in my tool,
1:20 I mark this as excluded because I don't need the generated output to be indexed and
1:25 it's going to have a static directory for things in the static website, like images and CSS files, templates that are used to help generate the site,
1:34 which we'll see in a subsequent step. Very importantly, it generated a configuration file for Sphinx, which we will look at in the next step,
1:43 a sample first document some tools to help build the site, and we still have our requirements.txt file.