ericholscher/sphinx-tutorial

For dummies installation tutorial for starting

Opened this issue · 2 comments

PetiPandaRou commented

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

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

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