Static Sites with Sphinx and Markdown Transcripts
Chapter: Setup
Lecture: Installing Sphinx
Login or
purchase this course
to watch this video and the rest of the course contents.
0:00
We have a blank Python project. We're now ready for our Sphinx installation.
0:05
What we'll do is we'll during this project will work methodically by having a requirements.txt
0:12
file that we put our website apps requirements into and then we'll use pip to install from there all from within our favorite editor.
0:23
For this course I'll be using the free and open source PyCharm community edition but
0:30
your choice of editor shouldn't matter too much use what you're comfortable with. Here I have my requirements.txt file open.
0:38
I've had one entry to it called Sphinx and my editor reminds me that my virtual environment does not have this installed.
0:46
So I'll sit in a terminal that has this virtual environment activated, which is what we did in the previous step so that I get the pip from
0:56
the virtual environment. And now when I run pip install, I'm going to point it at the requirements.txt file which contains Sphinx,
1:08
which will then go and get Sphinx to install as well as all the dependencies that Sphinx has. Once that's done.
1:18
I can kind of confirm that Sphinx was installed correctly by seeing if the path contains one of the Sphinx command line tools.
1:28
So I'll run 'which sphin quick start' and you see that my virtual environments bin directory thus indeed contain that console command.