Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
andreyzhd committed Aug 8, 2023
1 parent abfe473 commit 9c38e06
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 16 deletions.
18 changes: 11 additions & 7 deletions docs/install_win.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,21 @@ In the activated environment, type
An icon should appear on your desktop, which will activate the correct
environment and start the GUI.

Updating the package
--------------------

To update, give the command
If you get an error message running the above command (this might happen,
for example, if your computer has restrictions set up by your organization's
IT department), you can try running

::

pip install --upgrade https://github.com/NCH-Motion-Laboratory/gaitutils/archive/master.zip
python -c "from gaitutils.envutils import _make_gaitutils_shortcut; _make_gaitutils_shortcut()"

instead.

Updating the package
--------------------

Occassionally it may be beneficial or necessary to upgrade the dependencies as
well. Unfortunately, there's currently no simple way to do this. The best way
Unfortunately, there's currently no simple way to perform an upgrade
in a safe and reliable fashion. The best way
may be to simply delete the whole environment with

::
Expand Down
23 changes: 14 additions & 9 deletions docs/techdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,17 @@ latest GitHub master branch. It can then be updated with ``pip``. However,
developers and advanced users will wish to install in "git mode" instead (i.e.
run the package directly from a cloned repository). This can be done as follows:

- clone the repository from GitHub
- perform a normal install using the conda environment
- activate the new environment
- remove the pip install using ``pip uninstall gaitutils``
- change directory to root of cloned repository
- run ``pip install -e .`` (previously ``python setup.py develop`` which is now deprecated)
- Clone the repository from GitHub
- Perform a normal install using the conda environment. You may want to use the
development version of the conda environment specification -- ``environment_dev.yml``
for Windows or ``environment_linux_dev.yml`` for Linux. The development versions
of the specification do not specify package versions. This means that conda will try
to install the most recent versions of all the package requirements, potentially
leading to problems.
- Activate the new environment
- Remove the pip install using ``pip uninstall gaitutils``
- Change directory to root of cloned repository
- Run ``pip install -e .`` (previously ``python setup.py develop`` which is now deprecated)

Desktop shortcuts
-----------------
Expand All @@ -93,10 +98,10 @@ updated. Locally, the documentation can be recreated by running

::

./make.bat html
sphinx-build -b html docs docs-html

in the ``docs`` directory. The resulting html documentation will appear in
``docs/_build/html``.
in the project's root directory. The resulting html documentation will appear in
``docs-html`` directory.

To build the documentation, you need to have the ``sphinx_rtd_theme`` package
installed. It can be installed using ``pip``.
Expand Down

0 comments on commit 9c38e06

Please sign in to comment.