moved examples from docs into notebook, got rid of old analytics exam…

…ples
oseymour · Jun 17, 2024 · 5525b59 · 5525b59
1 parent 7c4c3a6
commit 5525b59
Show file tree

Hide file tree

Showing 8 changed files with 24,665 additions and 3,302 deletions.
diff --git a/Example.ipynb b/Example.ipynb
diff --git a/analytics_examples/data_viz_helpers.py b/analytics_examples/data_viz_helpers.py
diff --git a/analytics_examples/player_similarity/epl2022_reports_per90.pkl b/analytics_examples/player_similarity/epl2022_reports_per90.pkl
diff --git a/analytics_examples/player_similarity/epl2022_reports_perc.pkl b/analytics_examples/player_similarity/epl2022_reports_perc.pkl
diff --git a/analytics_examples/player_similarity/player_similarity_kmeans.ipynb b/analytics_examples/player_similarity/player_similarity_kmeans.ipynb
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -0,0 +1,12 @@
+===============
+Getting Started
+===============
+
+Installing ScaperFC is easy! Just go ahead and run ``pip install ScraperFC`` from the command line 
+and you should be good to go!
+
+To see examples of how to use ScraperFC, please see the ``Examples.ipynb`` notebook in the 
+`GitHub <https://github.com/oseymour/ScraperFC>`_ repository.
+
+And if you still have questions please join our `Discord <https://discord.com/invite/C5N8dqCJAq>`_ 
+or email me directly at [email protected].
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,13 +7,13 @@
 Welcome to ScraperFC's documentation!
 =====================================
 
-.. image:: ./images/ScraperFC-Logo-Final-2023-10-11\ copy-Full-Color.*
+.. image:: ./images/ScraperFC-Logo-Final-2023-10-11\ copy-Full-Color.svg
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
-   installation
+   getting_started
    apidocumentation
    year_parameter
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst