ReadtheDocs related

pjrigali · Aug 26, 2021 · 10ef5b5 · 10ef5b5
1 parent 3227d08
commit 10ef5b5
Show file tree

Hide file tree

Showing 40 changed files with 17,849 additions and 0 deletions.
diff --git a/docs/_build/.buildinfo b/docs/_build/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 4423beeacf66da548729795d195d703e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/.doctrees/classes.doctree b/docs/_build/.doctrees/classes.doctree
diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle
diff --git a/docs/_build/.doctrees/feature.doctree b/docs/_build/.doctrees/feature.doctree
diff --git a/docs/_build/.doctrees/glossary.doctree b/docs/_build/.doctrees/glossary.doctree
diff --git a/docs/_build/.doctrees/index.doctree b/docs/_build/.doctrees/index.doctree
diff --git a/docs/_build/.doctrees/intro.doctree b/docs/_build/.doctrees/intro.doctree
diff --git a/docs/_build/.doctrees/utils.doctree b/docs/_build/.doctrees/utils.doctree
diff --git a/docs/_build/_sources/classes.rst.txt b/docs/_build/_sources/classes.rst.txt
@@ -0,0 +1,53 @@
+Classes
+*******
+
+.. meta::
+   :description: This chapter describes how to edit, update, and build the Pyramid documentation.
+   :keywords: Pyramid, Style Guide
+
+This chapter documents the classes used.
+
+CallofDuty
+----------
+.. autoclass:: call_of_duty.CallofDuty
+    :members:
+
+DocumentFilter
+--------------
+.. autoclass:: document_filter.DocumentFilter
+    :members:
+
+Plot
+----
+.. autoclass:: plot.Line
+    :members:
+
+.. autoclass:: plot.Scatter
+    :members:
+
+.. autoclass:: plot.Histogram
+    :members:
+
+.. autoclass:: plot.Table
+    :members:
+
+Regression
+----------
+.. autoclass:: regression.Regression
+    :members:
+
+Squad
+-----
+.. autoclass:: squad.Performance
+    :members:
+
+.. autoclass:: squad.Person
+    :members:
+
+.. autoclass:: squad.Squad
+    :members:
+
+User
+----
+.. autoclass:: user.User
+    :members:
diff --git a/docs/_build/_sources/feature.rst.txt b/docs/_build/_sources/feature.rst.txt
@@ -0,0 +1,19 @@
+Intro
+=====
+
+Usage
+-----
+
+Calling the CallofDuty Class:
+
+.. code-block:: python
+
+   cod = CallofDuty(hacker_data=False, squad_data=True, streamer_mode=True)
+
+This is the core class which holds all objects the user may need.
+
+Write Ups and Examples
+----------------------
+`Home Page`_
+
+.. _Home Page: https://medium.com/@peterjrigali/call-of-duty-warzone-analysis-73a09b25ff38
diff --git a/docs/_build/_sources/glossary.rst.txt b/docs/_build/_sources/glossary.rst.txt
@@ -0,0 +1,13 @@
+Glossary
+========
+
+Terms used in this documentation.
+
+.. glossary::
+    :sorted:
+
+    *voom*
+        Theoretically, the sound a parrot makes when four-thousand volts of electricity pass through it.
+
+    *pining*
+        What the Norwegien Blue does when it misses its homeland, for example, pining for the fjords.
diff --git a/docs/_build/_sources/index.rst.txt b/docs/_build/_sources/index.rst.txt
@@ -0,0 +1,22 @@
+.. Warzone Analysis documentation master file, created by
+   sphinx-quickstart on Wed Aug 25 23:51:57 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Warzone Analysis's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   intro
+   classes
+   utils
+   glossary
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/docs/_build/_sources/intro.rst.txt b/docs/_build/_sources/intro.rst.txt
@@ -0,0 +1,19 @@
+Intro
+=====
+
+Usage
+-----
+
+Calling the CallofDuty Class:
+
+.. code-block:: python
+
+   cod = CallofDuty(hacker_data=False, squad_data=True, streamer_mode=True)
+
+This is the core class which holds all objects the user may need.
+
+Write Ups and Examples
+----------------------
+`Home Page`_
+
+.. _Home Page: https://medium.com/@peterjrigali/call-of-duty-warzone-analysis-73a09b25ff38
diff --git a/docs/_build/_sources/utils.rst.txt b/docs/_build/_sources/utils.rst.txt
@@ -0,0 +1,34 @@
+Utils
+*****
+
+.. meta::
+   :description: This chapter describes how to edit, update, and build the Pyramid documentation.
+   :keywords: Pyramid, Style Guide
+
+This chapter documents the Utils.
+
+Base
+----
+.. automodule:: base
+    :members:
+
+Build
+-----
+.. automodule:: build
+    :members:
+
+Outlier
+-------
+.. automodule:: outlier
+    :members:
+
+Plots
+------
+.. automodule:: plots
+    :members:
+
+Scrape
+------
+.. automodule:: scrape
+    :members:
+