Skip to content

Commit

Permalink
Update docs install documentation
Browse files Browse the repository at this point in the history
And do not use --generate-hashes option with pip-compile as it is not
compatible with editable installs.
See pypa/pip#4995
  • Loading branch information
winksaville committed Oct 8, 2020
1 parent 56c3bfd commit 9df0979
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 539 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -158,16 +158,18 @@ install-test: clean ## Install from test.pypi.org

.PHONY: install-dev
install-dev: ## Install from the sources for developemeent
#pip install -e .
pip install -e . -r dev-requirements.txt


# Update dependencies, used by update
# Note: You can not use --generate-hashes parameter with editable installs
.PHONY: update-deps
update-deps:
# No requirements in setup.py so skip
# pip-compile --upgrade --generate-hashes --allow-unsafe --output-file requirments.txt
# pip-compile --upgrade --allow-unsafe --output-file requirments.txt
# pip install --upgrade -r requirements.txt
pip-compile --upgrade --generate-hashes --allow-unsafe --output-file dev-requirements.txt dev-requirements.in
pip-compile --upgrade --allow-unsafe --output-file dev-requirements.txt dev-requirements.in
pip install --upgrade -r dev-requirements.txt

# Besure pip-tools is installed, used by update
Expand Down
32 changes: 20 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,9 @@ Generate helixes that can optionally taper to a point at each end.
* PyPi package: https://pypi.org/project/taperable-helix/
* Test PyPi package: https://test.pypi.org/project/taperable-helix/
* Free software: MIT license
* Source: `helix.py`_


Package Docs
------------

* docs: https://taperable-helix.readthedocs.io/en/latest/taperable_helix.html
* source: `helix.py`_

Examples
--------

Expand Down Expand Up @@ -103,12 +98,24 @@ Using
Development and Examples
########################

* sphinx
* plotly

* numpy
* panda
* python-kaleido
See `dev-requirements.txt`_ for most up to date list:

* pip-tools
* bump2version
* wheel
* isort
* black
* flake8
* tox
* tox-conda
* coverage
* Sphinx~=3.2
* sphinx-autodoc-typehints~=1.11
* sphinx-prompt~=1.3
* sphinx_substitution_extensions>=2020.09.30, <2021.12.00
* twine
* pytest
* pytest-runner

Credits
-------
Expand All @@ -124,3 +131,4 @@ package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_
.. _`helix.py`: https://github.com/winksaville/py-taperable-helix/blob/master/taperable_helix/helix.py
.. _`helical_line.py`: https://github.com/winksaville/py-taperable-helix/blob/master/examples/helical_line.py
.. _`helical_tri.py`: https://github.com/winksaville/py-taperable-helix/blob/master/examples/helical_tri.py
.. _`dev-requirements.txt`: https://github.com/winksaville/py-taperable-helix/blob/master/taperable_helix/helix.py
1 change: 1 addition & 0 deletions dev-requirements.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ tox
tox-conda
coverage
Sphinx~=3.2
sphinx_rtd_theme
sphinx-autodoc-typehints~=1.11
sphinx-prompt~=1.3
sphinx_substitution_extensions>=2020.09.30, <2021.12.00
Expand Down
Loading

0 comments on commit 9df0979

Please sign in to comment.