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

Point installation links to new installation guide in docs #5873

Merged
merged 2 commits into from
Jul 15, 2022
Merged

Point installation links to new installation guide in docs #5873

merged 2 commits into from
Jul 15, 2022

Conversation

fonnesbeck
Copy link
Member

Change install guide links to https://www.pymc.io/projects/docs/en/latest/installation.html instead of wiki

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -43,7 +43,7 @@
"\n",
"Running PyMC requires a relatively recent Python interpreter, preferrably version 3.8 or greater. A complete Python installation for Mac OSX, Linux and Windows can most easily be obtained by downloading and installing the free [`Anaconda Python Distribution`](https://store.continuum.io/cshop/anaconda/) by ContinuumIO or the open source [Miniforge](https://github.com/conda-forge/miniforge).\n",
"\n",
"Once Python is installed, follow the {ref}`platform-specific installation guides <installation>` on the PyMC GitHub repository.\n",
"Once Python is installed, follow the [insallation guide](https://www.pymc.io/projects/docs/en/latest/installation.html) on the PyMC documentation site.\n",
Copy link
Member

Choose a reason for hiding this comment

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

I think that should continue to be a sphinx-cross reference, we should only remove the platform-specific note

Copy link
Member

@michaelosthege michaelosthege Jul 12, 2022

Choose a reason for hiding this comment

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

Suggested change
"Once Python is installed, follow the [insallation guide](https://www.pymc.io/projects/docs/en/latest/installation.html) on the PyMC documentation site.\n",
"Once Python is installed, follow the {ref}`installation guide <installation>` on the PyMC documentation site.\n",

@OriolAbril like this? Can you commit it it correct? Let's get this merged

Copy link
Member

Choose a reason for hiding this comment

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

I edited the comment. I am on my mobile and it won't let me commit though, some refresh issue, probably buggy internetI am on the train. I removed the prural in guides as there are no longer multiple guides

Copy link
Member

Choose a reason for hiding this comment

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

I had the same problems. Had to do the commit locally..

@@ -43,7 +43,7 @@
"\n",
"Running PyMC requires a relatively recent Python interpreter, preferrably version 3.8 or greater. A complete Python installation for Mac OSX, Linux and Windows can most easily be obtained by downloading and installing the free [`Anaconda Python Distribution`](https://store.continuum.io/cshop/anaconda/) by ContinuumIO or the open source [Miniforge](https://github.com/conda-forge/miniforge).\n",
"\n",
"Once Python is installed, follow the {ref}`platform-specific installation guides <installation>` on the PyMC GitHub repository.\n",
"Once Python is installed, follow the [insallation guide](https://www.pymc.io/projects/docs/en/latest/installation.html) on the PyMC documentation site.\n",
Copy link
Member

Choose a reason for hiding this comment

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

I edited the comment. I am on my mobile and it won't let me commit though, some refresh issue, probably buggy internetI am on the train. I removed the prural in guides as there are no longer multiple guides

- `Installing PyMC on Linux <https://github.com/pymc-devs/pymc/wiki/Installation-Guide-(Linux)>`__
- `Installing PyMC on Windows <https://github.com/pymc-devs/pymc/wiki/Installation-Guide-(Windows)>`__

To install PyMC on your system, follow the instructions on the `installation guide <https://www.pymc.io/projects/docs/en/latest/installation.html>`__.
Copy link
Member

Choose a reason for hiding this comment

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

I would link to stable docs, not to latest. But unlike the comment/change below, this one should not be blocking

Copy link
Member

Choose a reason for hiding this comment

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

Nah, generally I'd agree, but for installation instructions in the past we often had to respond to changes/breaks in dependencies quickly, so I'd rather have people look at the latest up to date version.

@michaelosthege michaelosthege merged commit 8e92ac3 into pymc-devs:main Jul 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants