Merge pull request #8 from otavioon/docs

Docs
otavioon · Feb 2, 2024 · bd0cf7f · bd0cf7f
2 parents 5feb802 + 4875885
commit bd0cf7f
Show file tree

Hide file tree

Showing 23 changed files with 3,420 additions and 17 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,8 +1,8 @@
-name: ssl_tools
+name: ssl_tools documentation
 on:
   push:
     branches:
-    - main
+    - docs
 
 jobs:
   docs:
@@ -17,6 +17,11 @@ jobs:
       with:
         python-version: 3.12.1
 
+    - name: Install packages
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y pandoc
+
     - name: Install requirements
       run: |
         pip3 install sphinx sphinx-rtd-theme sphinx-autodoc-typehints sphinx-argparse sphinx-autoapi nbsphinx pandoc Ipython

diff --git a/.gitignore b/.gitignore
@@ -168,4 +168,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 ssl_tools/experiments/**/logs/
-data/*
+data/*
+notebooks/logs/*
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -0,0 +1,4 @@
+Contributing
+------------
+
+Under construction...
diff --git a/docs/experiments.rst b/docs/experiments.rst
@@ -0,0 +1,4 @@
+Running Experiments
+--------------------
+
+Under construction...
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,6 +11,9 @@ Welcome to SSLTools's documentation!
    :caption: Contents:
 
    installation
+   tutorials
+   experiments
+   contributing
    api
 
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,2 +1,4 @@
 Installation
------------------
+-----------------
+
+Under construction...
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -0,0 +1,7 @@
+ssl_tools
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   ssl_tools
diff --git a/docs/notebooks b/docs/notebooks
@@ -0,0 +1 @@
+../notebooks/
diff --git a/docs/ssl_tools.analysis.rst b/docs/ssl_tools.analysis.rst
@@ -0,0 +1,21 @@
+ssl\_tools.analysis package
+===========================
+
+Submodules
+----------
+
+ssl\_tools.analysis.plot\_metrics module
+----------------------------------------
+
+.. automodule:: ssl_tools.analysis.plot_metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ssl_tools.analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -0,0 +1,13 @@
+.. _tutorials:
+
+==========================
+Tutorials
+==========================
+
+..  toctree::
+    :maxdepth: 2
+
+    notebooks/01_structuring_input.ipynb
+    notebooks/02_training_model.ipynb
+    notebooks/03_training_ssl_model.ipynb
+    notebooks/04_using_experiments.ipynb