Skip to content

Simon-Deuring/sphinx-introduction

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to this guide about Sphinx!

Sphinx is a documentation generator that can also be used to generate blogs, websites, and books. This project shows you the first steps to get started with Sphinx. Moreover, the guide itself was created using Sphinx, so you can see all described reStructuredText directives in action.

Before you start you need to install Sphinx on your local machine as described here. Then you can clone this repository and build the documentation using make html from the shell. This command generates an HTML page under "_build/html" which you can open with a web browser of your choice. The Sphinx guide looks like this:

Sphinx

If you want to start even faster you can visit the online version of this Sphinx guide under https://simon-deuring.github.io/sphinx-introduction.