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.

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

Merged
merged 4 commits into from
Jun 25, 2024

Conversation

timhoffm
Copy link
Contributor

@timhoffm timhoffm commented Jun 21, 2024

  • 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.

@timhoffm timhoffm force-pushed the doc-installing branch 2 times, most recently from 5aa5c69 to 6d1b69f Compare June 21, 2024 22:40
@n-peugnet
Copy link
Contributor

You should take a look at this related issue: #12318

@timhoffm
Copy link
Contributor Author

@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 pip install or conda install command). For the inexperienced user, who is "blindly" following a recipe, it might still not be helpfull to start from scratch. They may have already followed another guide to set up a dev env and creating a separate doc environment is not ideal, e.g. because of potential import issues for autodoc and missing dependencies. Additionally, there are virtualenvs and conda envs and different tools (venv, poetry, pipx / conda, mamba ...) so that one definitive guide is not possible.

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.
@chrisjsewell
Copy link
Member

thanks for the explanation @timhoffm, will try to have a look soon

@jayaddison jayaddison added type:docs type:proposal a feature suggestion labels Jun 24, 2024
Copy link
Member

@chrisjsewell chrisjsewell left a 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

doc/usage/installation.rst Outdated Show resolved Hide resolved
doc/usage/installation.rst Outdated Show resolved Hide resolved
doc/usage/installation.rst Show resolved Hide resolved
@chrisjsewell chrisjsewell self-requested a review June 25, 2024 10:16
Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good!

@chrisjsewell chrisjsewell merged commit a53a758 into sphinx-doc:master Jun 25, 2024
7 checks passed
@timhoffm timhoffm deleted the doc-installing branch June 25, 2024 10:21
@timhoffm
Copy link
Contributor Author

Side question, which was not answered above: Do you still have development releases or should the section be removed?

@chrisjsewell
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs type:proposal a feature suggestion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants