Improve installation and usage docs #31
Conversation
nicoddemus
commented
Mar 21, 2017
nicoddemus
commented
- Remove pip install instructions
- Add more information to usage
* Remove pip install instructions * Add more information to usage
docs/usage.rst
Outdated
| * ``root``: this is the full path to the directory containing the ``environment.devenv.yml`` file; | ||
| * ``os``; | ||
| * ``sys``; | ||
| * ``platform``; |
There was a problem hiding this comment.
This platform is the module, right? Or is it sys.platform?
There was a problem hiding this comment.
The standard module, updated the docs to clarify that
docs/usage.rst
Outdated
| DB_LOCATION: https://localhost/dev | ||
|
|
||
| Environment variables defined in *list form* (like ``PATH`` and ``PYTHONPATH`` above) will **append** to existing | ||
| variables, using the appropriate separator for the platform (``:`` on Linux and ``;`` on Windows). |
docs/usage.rst
Outdated
| 1. Generate an ``environment.yml`` file in the same directory as the ``environment.devenv.yml`` file. The generated | ||
| ``environment.yml`` should **not** be added to VCS. | ||
| 2. Call ``conda env update --prune --file environment.yml``. | ||
| 3. Generate ``devenv-activate.sh/.bat`` and ``devenv-deactivate.sh/.bat`` scripts in ``$PREFIX/etc/conda/activate.d`` |
There was a problem hiding this comment.
devenv-activate.sh/.bat is kind of confusing, I would change to devenv-activate{.sh,.bat}, which by the way is a syntax supported by some shells to expand to multiple arguments
There was a problem hiding this comment.
Fair enough, changed 👍
There was a problem hiding this comment.
If we are going for some kind of standardized syntax for this I would suggest devenv-activate[.sh|.bat].
There is some reference =)
http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html
| 1. Generate an ``environment.yml`` file in the same directory as the ``environment.devenv.yml`` file. The generated | ||
| ``environment.yml`` should **not** be added to VCS. | ||
| 2. Call ``conda env update --prune --file environment.yml``. | ||
| 3. Generate ``devenv-activate{.sh,.bat}`` and ``devenv-deactivate{.sh,.bat}`` scripts in ``$PREFIX/etc/conda/activate.d`` |
There was a problem hiding this comment.
.fish is missing from the list
Also it may be worth listing somewhere the supported shells. If people start to use conda-devenv this question will certainly come up in the future, specially as conda introduces support for new shells (e.g. powershell)
The current version should work with bash, zsh, fish and cmd (maybe we should add integrated shell tests in the future?)
There was a problem hiding this comment.
Created an issue for the tests: #36
