Hint: You can adjust the default video playback speed in your account settings.
Hint: You can set the default subtitles language in your account settings.
Sorry! Looks like there’s an issue with video playback 🙁 This might be due to a temporary outage or because of a configuration issue with your browser. Please see our video player troubleshooting guide to resolve the issue.

Setting Up a Sphinx Example Project and Scaffolding

Give Feedback

This lesson covers setting up an example project in order to demonstrate how to create scaffolding for documentation. You will learn how to install Sphinx and how to configure it using its Quick Start Wizard. The Wizard allows you to set common options quickly such as author details, file format for the documentation files, and whether or not to create make files for each project.

Towards the end of the lesson, you’ll see how to build HTML documentation for your project using the make html command.

Anonymous on March 29, 2019

Any tutorial for doing the Sphinx Documentation for windows users?

Anonymous on March 29, 2019

I use windows system with pycharm as my editor. I’m git bash on pycharm as my terminal. I was able to execute all the commands till “make html”. “make html” gives me the following error: bash: make: command not found. Any help resolving this will be highly appreciated.

john09 on July 28, 2019

I’m using a Mac and PyCharm. I install sphinx and run sphinx-quickstart. The prompts I see are almost completely different. So, on lesson 2, I’m lost.

mthomp89 on May 12, 2020

On Windows 10. Prompts and output are very different. Is there work on a Windows tutorial?

Dan Bader RP Team on May 12, 2020

This course currently requires a Linux (or macOS) command-line environment for running the Sphinx make commands . We’re planning to update this course for Python 3 and Windows in the future.

Become a Member to join the conversation.