diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..1af1692 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,15 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "3.12" + jobs: + post_create_environment: + - pip install poetry + - poetry config virtualenvs.create false + post_install: + - poetry install + +sphinx: + configuration: docs/source/conf.py diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..a520608 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,7 @@ +API +=== + +.. autosummary:: + :toctree: generated + + pyzipline diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..655792e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,35 @@ +# 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' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..6efa63c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,19 @@ +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 diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..b411389 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,13 @@ +Usage +===== + +.. _installation: + +Installation +------------ + +To use PyZipline, first install it using pip: + +.. code-block:: console + + (.venv) $ pip install lumache