diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 5c7c80c38..774029c27 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -5,26 +5,39 @@ Contributing ############ We encourage contributions to mirdata, especially new dataset loaders. To contribute a new loader, follow the -steps indicated below and create a Pull Request (PR) to the github repository. +steps indicated below and create a Pull Request (PR) to the github repository. For any doubt or comment about +your contribution, you can always submit an issue or open a discussion in the repository. - `Issue Tracker `_ - `Source Code `_ -Installing and running tests -############################# +Installing mirdata for development purposes +########################################### +To install ``mirdata`` for development purposes: -First, clone the repository from github: + - First run: -.. code-block:: bash + .. code-block:: console + + git clone https://github.com/mir-dataset-loaders/mirdata.git + + - Then, after opening source data library you have to install the dependencies for updating the documentation + and running tests: + + .. code-block:: console - git clone git@github.com:mir-dataset-loaders/mirdata.git + pip install . + pip install .[tests] + pip install .[docs] + pip install .[dali] -We recommend you install `pyenv `_ to manage your Python versions -and install all ``mirdata`` requirements. You will want to install the latest versions of Python 3.6 and 3.7. -Once ``pyenv`` and the Python versions are configured, install ``pytest``. Finally, run : +We recommend to install `pyenv `_ to manage your Python versions +and install all ``mirdata`` requirements. You will want to install the latest versions of Python 3.6 and 3.7. +Once ``pyenv`` and the Python versions are configured, install ``pytest``. Make sure you installed all the pytest +plugins to automatically test your code successfully. Finally, run: .. code-block:: bash diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst index 28bf66e82..61df5aa28 100644 --- a/docs/source/tutorial.rst +++ b/docs/source/tutorial.rst @@ -8,26 +8,10 @@ Installation ------------ To install ``mirdata``: - .. code-block:: console - - pip install mirdata - -To install ``mirdata`` for development purposes: - - First run: - - .. code-block:: console - - git clone https://github.com/mir-dataset-loaders/mirdata.git - - - Then, after opening source data library you have to install the dependencies: .. code-block:: console - pip install . - pip install .[tests] - pip install .[docs] - pip install .[dali] - + pip install mirdata Usage -----