Update Contributing Environment section #18052
Conversation
|
general approach looks nice. |
| of the docs, greatly reducing the turn-around time for checking your changes. | ||
| You will be prompted to delete ``.rst`` files that aren't required. This is okay because | ||
| the prior versions of these files can be checked out from git. However, you must make sure | ||
| You can tell ``make.py`` to compile only a single section of the docs, greatly |
There was a problem hiding this comment.
add a pointer that says the very first thing you have to do is create the dev env (refer to the section above)
Codecov Report
@@ Coverage Diff @@
## master #18052 +/- ##
==========================================
- Coverage 91.24% 91.23% -0.02%
==========================================
Files 163 163
Lines 50114 50114
==========================================
- Hits 45729 45720 -9
- Misses 4385 4394 +9
Continue to review full report at Codecov.
|
TomAugspurger
changed the title
| @@ -0,0 +1,27 @@ | |||
| # This file was autogenerated by scripts/convert_deps.py | |||
| # Do not modify directlybeautifulsoup4 | |||
There was a problem hiding this comment.
missing a new line in the convert script
doc/source/contributing.rst
Outdated
| to updating. This will effectively store your changes and they can be reapplied | ||
| after updating. | ||
| Let us know if you have any difficulties by `opening an issue | ||
| <https://github.com/pandas-dev/pandas/issues/new>`_. |
There was a problem hiding this comment.
Maybe rather point to asking on gitter compared to directly opening an issue? (or both)
doc/source/contributing.rst
Outdated
| - Install either :ref:`Anaconda <install.anaconda>` or :ref:`miniconda <install.miniconda>` | ||
| - Install either `Anaconda <https://www.anaconda.com/download/>`_ or `miniconda | ||
| <https://conda.io/miniconda.html>`_ | ||
| - Make sure your conda is up to date (`conda update conda`) |
doc/source/contributing.rst
Outdated
|
|
||
| To work in this environment, Windows users should ``activate`` it as follows:: | ||
| # Install the rest of the optional dependencies | ||
| conda install -c defaults -c conda-forge --file=ci/requirements-optional-conda.txt |
There was a problem hiding this comment.
What does this exactly do by specifying both? First look at defaults and otherwise look at conda-forge?
There was a problem hiding this comment.
Correct. IIRC we have deps that are conda-forge only. I suppose we maybe just to -c conda-forge and no defaults.
|
|
||
| Creating a development environment | ||
| ---------------------------------- | ||
| Creating a Python Environment |
There was a problem hiding this comment.
add "(conda)" between brackets? (as is done for pip)
doc/source/contributing.rst
Outdated
|
|
||
| or use the `Microsoft Visual Studio VC++ compiler for Python <https://www.microsoft.com/en-us/download/details.aspx?id=44266>`__. Note that you have to check the ``x64`` box to install the ``x64`` extension building capability as this is not installed by default. | ||
| Creating a Python Environment (pip) | ||
| ----------------------------------- |
There was a problem hiding this comment.
Should this have the same header level as the conda one?
| ipython | ||
| ipykernel | ||
| jinja2 | ||
| lxml |
There was a problem hiding this comment.
you added this already (lxml), thanks!
| git rebase upstream/master | ||
| - https://blogs.msdn.microsoft.com/pythonengineering/2016/04/11/unable-to-find-vcvarsall-bat/ | ||
| - https://github.com/conda/conda-recipes/wiki/Building-from-Source-on-Windows-32-bit-and-64-bit | ||
| - https://cowboyprogrammer.org/building-python-wheels-for-windows/ |
There was a problem hiding this comment.
we should prob update these and eliminate the older ones
There was a problem hiding this comment.
Yes, I'll go through these later today and remove the old / outdated ones.
|
thanks @TomAugspurger awesome! |
|
in future PR can add a note in the documentation section of whatsnew |
(cherry picked from commit 0fd3bd7)
(cherry picked from commit 0fd3bd7)
Closes #18041
Closes #17544
Closes #17747
Still need to
But I wanted to get this out there to check if people are OK with the general approach of
And if people are able to test this on their machine I'd be grateful. I've tested both conda and pip/venv on my mac.