Merge docs into competition

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Install Synthetix
+        run: |
+          pip install -e ./src
+      - name: Sphinx build
+        run: |
+          cd docs && make html
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/v3-competition' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

docs/Makefile

@@ -0,0 +1,20 @@
+# 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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,24 @@
+project = 'Synthetix'
+copyright = '2023, Synthetix DAO'
+author = 'Synthetix DAO'
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx_rtd_theme",
+]
+autosummary_generate = True
+
+templates_path = ['_templates']
+
+exclude_patterns = [
+    '*/constants.py', # TODO: Figure out why this doesn't work
+    '.DS_Store',
+    'deployments/*'
+]
+
+source_suffix = [".rst", ".md"]
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,9 @@
+Synthetix Documentation
+=======================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Reference
+
+   modules/synthetix
+   modules/utils

docs/source/modules/multicall.rst

@@ -0,0 +1,7 @@
+Multicall
+===========================
+
+.. automodule:: synthetix.utils.multicall
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/synthetix.rst

@@ -0,0 +1,13 @@
+Synthetix
+===========================
+
+.. autoclass:: synthetix.Synthetix
+   :members:
+   :private-members:
+
+.. autoclass:: synthetix.perps.Perps
+   :members:
+   :private-members:
+
+.. autoclass:: synthetix.pyth.Pyth
+   :members:

docs/source/modules/utils.rst

@@ -0,0 +1,7 @@
+Utils
+===========================
+
+.. automodule:: synthetix.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

requirements.txt

@@ -4,3 +4,6 @@ autopep8
 pre-commit
 python-dotenv
 pytest
+sphinx
+sphinx-rtd-theme
+myst-parser