Sphinx Documentation

docs/source/conf.py

@@ -0,0 +1,53 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../../'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'python-aternos'
+copyright = '2022, DarkCat09'
+author = 'DarkCat09'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0.6'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. python-aternos documentation master file, created by
+   sphinx-quickstart on Fri Jun 17 14:02:03 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to python-aternos's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,8 @@
+python-aternos
+==============
+
+.. toctree::
+   :maxdepth: 4
+
+   python_aternos
+   setup

docs/source/python_aternos.rst

@@ -0,0 +1,93 @@
+python\_aternos package
+=======================
+
+Submodules
+----------
+
+python\_aternos.atclient module
+-------------------------------
+
+.. automodule:: python_aternos.atclient
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atconf module
+-----------------------------
+
+.. automodule:: python_aternos.atconf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atconnect module
+--------------------------------
+
+.. automodule:: python_aternos.atconnect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.aterrors module
+-------------------------------
+
+.. automodule:: python_aternos.aterrors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atfile module
+-----------------------------
+
+.. automodule:: python_aternos.atfile
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atfm module
+---------------------------
+
+.. automodule:: python_aternos.atfm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atjsparse module
+--------------------------------
+
+.. automodule:: python_aternos.atjsparse
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atplayers module
+--------------------------------
+
+.. automodule:: python_aternos.atplayers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atserver module
+-------------------------------
+
+.. automodule:: python_aternos.atserver
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+python\_aternos.atwss module
+----------------------------
+
+.. automodule:: python_aternos.atwss
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: python_aternos
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance: