WOOOO im going insane

docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/css/material.css

@@ -0,0 +1,27 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+    padding-left: 25px;
+    border-left: .05rem solid var(--md-typeset-table-color);
+  }
+
+  /* Mark external links as such. */
+  a.external::after,
+  a.autorefs-external::after {
+    /* https://primer.style/octicons/arrow-up-right-24 */
+    mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+    -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+    content: ' ';
+
+    display: inline-block;
+    vertical-align: middle;
+    position: relative;
+
+    height: 1em;
+    width: 1em;
+    background-color: var(--md-typeset-a-color);
+  }
+
+  a.external:hover::after,
+  a.autorefs-external:hover::after {
+    background-color: var(--md-accent-fg-color);
+  }

docs/index.md

@@ -0,0 +1,20 @@
+# Welcome to PyZipline
+
+**PyZipline** is a Python API Wrapper for the [Zipline](https://zipline.diced.sh/) API.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`install` the project.
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/ref/zipline.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: pyzipline.zipline

docs/source/api.rst

@@ -1,19 +0,0 @@
-API Reference
-===
-
-.. autosummary::
-   :toctree: generated
-
-   pyzipline
-
-
-.. automodule:: zipline
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :inherited-members:
-   :noindex:
-   :exclude-members: __init__, __repr__, __str__
-
-   .. automethod:: zipline.function_name
-      :noindex:

docs/source/conf.py

@@ -1,36 +0,0 @@
-# pylint: skip-file
-# Configuration file for the Sphinx documentation builder.
-
-# -- Project information
-
-project = 'PyZipline'
-copyright = '2023, SeaswimmerTheFsh'
-author = 'SeaswimmerTheFsh'
-
-release = '3.7.7'
-version = '0.1.0'
-
-# -- General configuration
-
-extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-]
-
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-}
-intersphinx_disabled_domains = ['std']
-
-templates_path = ['_templates']
-
-# -- Options for HTML output
-
-html_theme = 'sphinx_rtd_theme'
-
-# -- Options for EPUB output
-epub_show_urls = 'footnote'

docs/source/index.rst

@@ -1,20 +0,0 @@
-Welcome to PyZipline's documentation!
-===================================
-
-**PyZipline** is a Python API Wrapper for the Zipline API.
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
-
-.. note::
-
-   This project is under active development.
-
-Contents
---------
-
-.. toctree::
-
-   usage
-   api
-   models

docs/source/models.rst

@@ -1,7 +0,0 @@
-API Reference
-===
-
-.. automodule:: pyzipline.models
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/source/usage.rst

@@ -1,13 +0,0 @@
-Usage
-=====
-
-.. _installation:
-
-Installation
-------------
-
-To use PyZipline, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install lumache