Skip to content

Commit

Permalink
Merge pull request #69 from ITC-CRIB/manuGil-patch-1
Browse files Browse the repository at this point in the history
Test are not relevant, this PR only includes changes to documentation
  • Loading branch information
manuGil committed May 14, 2024
2 parents 87fd582 + 29ca6c6 commit db70fa2
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 101 deletions.
9 changes: 8 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,19 @@ Installation
------------

*fairly* requires Python 3.8 or later, and `ruamel.yaml` version *0.17.26* or later. It can be installed directly
using pip.
from **PYPI** or **Conda-Forge**.

.. code:: shell
# Using pip
pip install fairly
.. code:: shell
# using anaconda or miniconda
conda install conda-forge::fairly
Installing from source
~~~~~~~~~~~~~~~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion docs/api/fairly.client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ fairly.client.figshare module
:show-inheritance:

fairly.client.invenio module
---------------------------
----------------------------

.. automodule:: fairly.client.invenio
:members:
Expand All @@ -35,3 +35,4 @@ Module contents
:members:
:undoc-members:
:show-inheritance:
:noindex:
1 change: 1 addition & 0 deletions docs/api/fairly.dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Module contents
:members:
:undoc-members:
:show-inheritance:
:noindex:
10 changes: 8 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The *Fairly Toolset* provides functionality for the core tasks of preparing, upl
Installing the Toolset
------------------------

You can install the full toolset by installing the JupyterLab extension from PyPI. The fairly package and CLI will be installed automatically.
You can install the *full toolset* by installing the JupyterLab extension from PyPI. The fairly package and CLI will be installed automatically.

Linux / MacOS
'''''''''''''''''''
Expand Down Expand Up @@ -56,12 +56,18 @@ If all you need is the *fairly* Python package and the CLI, you can install them
Linux / MacOS
'''''''''''''''''''

On the terminal type:
On the terminal type, for PyPI:

.. code-block:: shell
pip install fairly
Or if using Anaconda or Miniconda:

.. code-block:: shell
conda install conda-forge::fairly
Installing from Source
'''''''''''''''''''''''''
Expand Down
51 changes: 0 additions & 51 deletions docs/osf2023.rst

This file was deleted.

46 changes: 0 additions & 46 deletions docs/package/installation.rst

This file was deleted.

0 comments on commit db70fa2

Please sign in to comment.