doc init

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,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Synthetix'
+copyright = '2023, Synthetix DAO'
+author = 'Synthetix DAO'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+]
+
+templates_path = ['_templates']
+exclude_patterns = [
+    '**/constants.py',
+]
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. Synthetix documentation master file, created by
+   sphinx-quickstart on Tue Aug 22 11:46:53 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Synthetix's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+synthetix
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   synthetix

docs/source/synthetix.contracts.deployments.rst

@@ -0,0 +1,10 @@
+synthetix.contracts.deployments package
+=======================================
+
+Module contents
+---------------
+
+.. automodule:: synthetix.contracts.deployments
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.contracts.rst

@@ -0,0 +1,29 @@
+synthetix.contracts package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   synthetix.contracts.deployments
+
+Submodules
+----------
+
+synthetix.contracts.contracts module
+------------------------------------
+
+.. automodule:: synthetix.contracts.contracts
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix.contracts
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.perps.rst

@@ -0,0 +1,29 @@
+synthetix.perps package
+=======================
+
+Submodules
+----------
+
+synthetix.perps.constants module
+--------------------------------
+
+.. automodule:: synthetix.perps.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+synthetix.perps.perps module
+----------------------------
+
+.. automodule:: synthetix.perps.perps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix.perps
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.pyth.rst

@@ -0,0 +1,29 @@
+synthetix.pyth package
+======================
+
+Submodules
+----------
+
+synthetix.pyth.constants module
+-------------------------------
+
+.. automodule:: synthetix.pyth.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+synthetix.pyth.pyth module
+--------------------------
+
+.. automodule:: synthetix.pyth.pyth
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix.pyth
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.queries.rst

@@ -0,0 +1,37 @@
+synthetix.queries package
+=========================
+
+Submodules
+----------
+
+synthetix.queries.config module
+-------------------------------
+
+.. automodule:: synthetix.queries.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+synthetix.queries.gql module
+----------------------------
+
+.. automodule:: synthetix.queries.gql
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+synthetix.queries.queries module
+--------------------------------
+
+.. automodule:: synthetix.queries.queries
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix.queries
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.rst

@@ -0,0 +1,41 @@
+synthetix package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   synthetix.contracts
+   synthetix.perps
+   synthetix.pyth
+   synthetix.queries
+   synthetix.utils
+
+Submodules
+----------
+
+synthetix.constants module
+--------------------------
+
+.. automodule:: synthetix.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+synthetix.synthetix module
+--------------------------
+
+.. automodule:: synthetix.synthetix
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/synthetix.utils.rst

@@ -0,0 +1,21 @@
+synthetix.utils package
+=======================
+
+Submodules
+----------
+
+synthetix.utils.wei module
+--------------------------
+
+.. automodule:: synthetix.utils.wei
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: synthetix.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

requirements.txt

@@ -7,4 +7,6 @@ web3==6.0.0
 autopep8
 pre-commit
 python-dotenv
-pytest
+pytest
+sphinx
+sphinx-rtd-theme