Skip to content

Commit

Permalink
DOC: Mention extension loading in setup page
Browse files Browse the repository at this point in the history
(Closes #304)
(Closes #302)
  • Loading branch information
bpoldrack committed Apr 6, 2024
1 parent fbc0e0e commit da9cfe7
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/settingup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,20 @@ Installation
# install from PyPi
$ pip install datalad-dataverse
In order to allow additional features for `datalad push` and `datalad clone`
to be enabled, the `datalad.extensions.load` config must be set to `next` and `dataverse`.
Configurations can be set at the dataset level (`.datalad/config` within the dataset) or
any git-config location (local, global, system).
To set it globally (meaning it's stored in your `~/.gitconfig`) run:

.. code-block:: bash
# Make sure datalad-next is loaded whenever a datalad command runs;
# This allows to git push/fetch from/to a dataverse dataset:
$ git config --global --add datalad.extensions.load next
# Same thing for datalad-dataverse, enabling datalad-clone directly
# from the URL of a dataverse dataset landing page.
$ git config --global --add datalad.extensions.load dataverse
Getting started
^^^^^^^^^^^^^^^
Expand Down

0 comments on commit da9cfe7

Please sign in to comment.