-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
DOC: Rewrite installation instructions #12458
Conversation
5aa5c69
to
6d1b69f
Compare
You should take a look at this related issue: #12318 |
@n-peugnet thanks for the hint. IMHO this PR is mostly in line with the discussion. The only difference is, that I've put the environment creation in a tip at the top and link out for details instead of walking the users through explicitly. The motivation is the following. Sphinx users, i.e. people who care to produce compiled documentation are likely not the very beginners. Since environments are quite common nowadays I expect that most sphinx users will have a basic understanding of environments. Walking through the environment creation process is rather a distraction for the experienced user (they know the installation scpoe they want when they see a Overall, I believe that the environment topic is too diverse and complex to be addressed meaningfully inside the Sphinx installation guide. Thus we should recommend to use environments but not try to explain their usage explicitly. |
- Put pip and conda as the most common options first - Don't distinguish Linux / Windows in the pip commands. They are equivalent and users should be able to get this right even without the distinction. - Replace the venv instructions by a general tip to use environments and link out for details. - Collect all OS-specific package manager in one section - Remove the "Windows - Other methods" secion. This is basically pip (or conda). It's beyond the scope of Sphinx to explain how to set up Python. - Move latest development release to a separate entry. *Question*: Do you still do development releases? I just got the latest stable by that.
thanks for the explanation @timhoffm, will try to have a look soon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Definitely agree with the re-ordering and addition of conda,
just some suggestions for installing with pinned dependencies
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all good!
Side question, which was not answered above: Do you still have development releases or should the section be removed? |
well not currently, but lets leave in for now as might when approaching v8 |
Question: Do you still do development releases? I just got the latest stable by that.