Skip to content

Commit

Permalink
Added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
otavioon committed May 29, 2024
1 parent 3eedb63 commit 6c6b034
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 10 deletions.
4 changes: 0 additions & 4 deletions docs/experiments.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Welcome to Minerva's documentation!

installation
tutorials
experiments
contributing
api


Expand Down
17 changes: 14 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
Installation
-----------------
.. _installation:

==========================
Installation Guide
==========================

Pip Installation
---------------------

To install Minerva, you can use pip:

.. code-block:: bash
pip install minerva
Under construction...
7 changes: 7 additions & 0 deletions docs/notebooks/1.datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,13 @@
"\n",
"This structured approach ensures clarity and flexibility in handling different tasks and data organizations."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"![Figure Title](figures/dataset_readers.svg)"
]
}
],
"metadata": {
Expand Down
4 changes: 4 additions & 0 deletions docs/notebooks/figures/dataset_readers.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Tutorials
.. toctree::
:maxdepth: 2

Under construction
notebooks/1.datasets.ipynb

0 comments on commit 6c6b034

Please sign in to comment.