Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

For dummies installation tutorial for starting #2

Open
PetiPandaRou opened this issue Nov 5, 2015 · 2 comments
Open

For dummies installation tutorial for starting #2

PetiPandaRou opened this issue Nov 5, 2015 · 2 comments

Comments

@PetiPandaRou
Copy link

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
Copy link
Author

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PetiPandaRou