Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
TsumiNa committed Jan 28, 2021
1 parent 6310ffa commit 6b8f39f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/source/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Contribution guidelines
=======================

1. Fork it ( https://github.com/yoshida-lab/XenonPy/fork )
2. Extend your python environment to support XenonPy development (See: :ref:`installation:installing in development mode`.).
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
Expand Down
13 changes: 4 additions & 9 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ This will change file permission to ``r+w`` for all users.
Installing in development mode
------------------------------

To use the latest development version distributed at `Github repository`_,
just clone the repository to create a local copy:
The user who plans to contribute to XenonPy has to extend the python environment to support pytest and other development tools.
The simplest way to extend your environment is using `extra_env.yml`_.

.. code-block:: bash
Expand All @@ -153,14 +153,9 @@ under the cloned folder, run the following to install XenonPy in development mod
.. code-block:: bash
$ cd XenonPy
$ conda env update -n <your_env_name> -f devtools/extra_env.yml
$ pip install -e .
To update XenonPy, use ``git fetch && git pull``

.. code-block:: bash
$ git fetch && git pull
----------------------
Expand All @@ -178,7 +173,7 @@ Please provide detailed information (system specification, Python version, and i
.. _yoshida-lab channel: https://anaconda.org/yoshida
.. _pip: https://pip.pypa.io
.. _docker image: https://docs.docker.com
.. _Github repository: https://github.com/yoshida-lab/XenonPy
.. _extra_env.yml: https://github.com/yoshida-lab/XenonPy/blob/master/devtools/extra_env.yml
.. _issues: https://github.com/yoshida-lab/XenonPy/issues
.. _Gitter: https://gitter.im/yoshida-lab/XenonPy
.. _PyTorch: http://pytorch.org/
Expand Down

0 comments on commit 6b8f39f

Please sign in to comment.