For dummies installation tutorial for starting

ericholscher / sphinx-tutorial

An opinionated tutorial on Sphinx.

56 stars 151 forks source link

For dummies installation tutorial for starting #2

Open PetiPandaRou opened 8 years ago

PetiPandaRou commented 8 years ago

The installation part (http://sphinx-tutorial.readthedocs.org/start/) should be more "for the dummies" oriented:

What are prerequisites for the installation ?
On which OS is it possible to install it ?
How do I create my first Sphinx documentation page ?

PetiPandaRou commented 8 years ago

Also, it could be great to be more proactive on users' possible errors. For example, for pip install sphinx, you can explain that it's possible to have an permission error. I had it and rerun the command with sudo.

PetiPandaRou commented 8 years ago

Also what is the command to run the python server permanently ? This could be usefull.