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