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

Switch to pip install in documentation. Ignore build directory. #55

Open

cmarmo wants to merge 1 commit into Keck-DataReductionPipelines:documentation from cmarmo:documentation-pip

cmarmo commented Jan 20, 2022

Dear maintainer(s),

while installing for the first time the framework on a Linux system (Fedora) following the documentation I faced some issues.

the python setup.py install does not allow to install if the installation is not performed with sudo access (as expected)
when creating a fresh virtual environment without installing the dependencies, astropy 5.0 is downloaded and it complains about the extension_helpers not being installed (related to the deprecation of the astropy_helpers module).

To avoid these issues I'm proposing to modify the documentation and use

pip install .

This allows to install without sudo rights even without virtual environment and it also manages the dependencies correctly.

In addition, I have added a .gitignore specific to the documentation directory.

Thanks for considering this pull request!


          Switch to pip install in documentation. Ignore build directory.

d2d25f8

MNBrod commented Jan 31, 2022

Yup! These are changes I have been thinking about for a while but never got around to. I will merge this in with the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment