Static Sites with Sphinx and Markdown Transcripts
Lecture: Installing Sphinx
0:00 We have a blank python project.
0:02 We're now ready for our Sphinx installation.
0:04 What we'll do is we'll during this project will work methodically by having a requirements.txt
0:11 file that we put our website apps requirements into and then we'll use pip to
0:17 install from there all from within our favorite editor.
0:22 For this course I'll be using the free and open source PyCharm community edition but
0:29 your choice of editor shouldn't matter too much use what you're comfortable with. Here
0:34 I have my requirements.txt file open.
0:37 I've had one entry to it called Sphinx and my editor reminds me that my virtual
0:42 environment does not have this installed.
0:45 So I'll sit in a terminal that has this virtual environment activated,
0:50 which is what we did in the previous step so that I get the pip from
0:55 the virtual environment. And now when I run pip install,
1:02 I'm going to point it at the requirements.txt file which contains Sphinx,
1:07 which will then go and get Sphinx to install as well as all the dependencies that
1:14 Sphinx has. Once that's done.
1:17 I can kind of confirm that Sphinx was installed correctly by seeing if the path contains
1:24 one of the Sphinx command line tools.
1:27 So I'll run 'which sphin quick start' and you see that my virtual environments bin directory thus indeed contain that console command.