Set up docs index

ImperialCollegeLondon · May 17, 2024 · 9d7a6b7 · 9d7a6b7
1 parent bf8c9f9
commit 9d7a6b7
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 PyProBE is a Python library for the analysis of battery cycling data.
 
 ## Using PyProBE
+See the [documentation](https://congenial-adventure-mz797n5.pages.github.io) for a detailed getting started guide.
+
+You can find example notebooks in the [examples folder](examples/).
+
 PyProBE should be imported as a package into an external post-processing script or jupyter notebook.
 
 ```python

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -0,0 +1,4 @@
+Getting Started
+=======
+
+1. Clone the repository
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,9 +7,11 @@ Welcome to PyProBE's documentation!
 ===================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
+   getting_started
+   modules
 
 
 Indices and tables

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,4 +1,4 @@
-pyprobe
+API Reference
 =======
 
 .. toctree::