Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention git hooks in install documentation #5647

Merged
merged 3 commits into from
Apr 19, 2014
Merged

Mention git hooks in install documentation #5647

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f438d68
Mention git hooks in install documentation
koldunovn Apr 16, 2014
c2b29e2
Fix on fix of install documentation
Apr 17, 2014
eaa6854
change git to git hooks
Apr 17, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/source/install/install.rst
View file
Open in desktop
Expand Up @@ -174,13 +174,31 @@ step by:
$ python setupegg.py develop

This creates links in the right places and installs the command line script to
the appropriate places. Then, if you want to update your IPython at any time,
the appropriate places.

Then, if you want to update your IPython at any time,
just do:

.. code-block:: bash

$ git pull

IPython now uses git submodules to ship its javascript dependencies. If you run
IPython from git master, you may need to update submodules once in a while with:

.. code-block:: bash

$ git submodule update

or

.. code-block:: bash

$ python setup.py submodule

Another option is to copy `git hooks <https://github.com/ipython/ipython/tree/master/git-hooks>`_
to your ``./git/hooks/`` directory to ensure that your submodules are up to date on each pull.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prompted by #5587 there seem to be git-hoooks/install-hooks.sh do you want to mention it too ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Carreau It's convenient, but not really necessary (simple copying will do the same). There is already quite a lot of details in this section, so I wouldn't add more.


Basic optional dependencies
===========================
Expand Down