Added documentation of pyDataverse conda installation (again) - Githubissues

gdcc / pyDataverse

Python module for Dataverse Software (dataverse.org).

http://pydataverse.readthedocs.io/

MIT License

64 stars 45 forks source link

Added documentation of pyDataverse conda installation (again) #184

Closed PennyHow closed 4 months ago

PennyHow commented 4 months ago

These are minor edits to pyDataverse docs to include documentaion on the new conda install, as discussed here - https://github.com/gdcc/pyDataverse/issues/159

Platforms

[X] OS: NAME, VERSION, 64/32bit
- Linux 64-bit
[X] pyDataverse: VERSION
- v0.3.1
[X] Python: VERSION
- Python 3.8
[ ] Dataverse: VERSION
- NA

Follow best practices

[X] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
[X] Have you followed the guidelines in our Contribution Guide?
[X] Have you read the Code of Conduct?
[X] Do your changes in a seperate branch. Branches MUST have descriptive names.
[X] Have you merged the latest changes from upstream to your branch?

Describe the PR

[X] What kind of change does this PR introduce?
- docs
[X] Why is this change required? What problem does it solve?
- Updating pyDataverse docs with information about how to install the package with conda
[ ] Screenshots (if appropriate)
[X] Put Closes #ISSUE_NUMBER to the end of this pull request

Testing

[ ] Have you used tox and/or pytest for testing the changes?
[ ] Did the local testing ran successfully?
[ ] Did the Continous Integration testing (Travis-CI) ran successfully?

Commits

[X] Have descriptive commit messages with a short title (first line).
[ ] Use the commit message template
[ ] Put Closes #ISSUE_NUMBER in your commit messages to auto-close the issue that it fixes (if such).

Others

[X] Is there anything you need from someone else?
- If anyone else has anything to add then please do. Also, I added the conda install instructions to the index.rst page as well as the installation page. I know though that you might want to keep the front page simplified and only include the conda install on the installation page (along with the instructions on installing with pipenv). If so, then please feel free to alter accordingly.

Documentation contribution

[X] Have you followed NumPy Docstring standard?

Code contribution

[ ] Have you used pre-commit?
[ ] Have you formatted your code with black prior to submission (e. g. via pre-commit)?
[ ] Have you written new tests for your changes?
[ ] Have you ran mypy on your changes successfully?
[ ] Have you documented your update (Docstrings and/or Docs)?
[ ] Do your changes require additional changes to the documentation?

Closes https://github.com/gdcc/pyDataverse/issues/159