Update docs

docs/make.bat

@@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=build
 
-if "%1" == "" goto help
-
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -21,10 +19,12 @@ if errorlevel 9009 (
 	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/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

docs/source/conf.py

@@ -1,64 +1,28 @@
-from os.path import abspath
-from sys import path
-
-import sphinx_rtd_theme
-
-path.insert(0, abspath('../../'))
-
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
+# For the full list of built-in configuration values, see the documentation:
-# 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 -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'rcon'
-copyright = '2020, Richard Neumann'
+copyright = '2022, Richard Neumann'
 author = 'Richard Neumann'
-
+release = '2.3.6'
-# The full version, including alpha/beta/rc tags
-release = '1.0.0'
-
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
+extensions = ['sphinx.ext.autodoc']
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx_rtd_theme',
-    '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
+# -- Options for HTML output -------------------------------------------------
-# a list of builtin themes.
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-#
-html_theme = 'sphinx_rtd_theme'
 
-# Add any paths that contain custom static files (such as style sheets) here,
+html_theme = 'alabaster'
-# 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/modules.rst

@@ -1,5 +1,5 @@
-Modules
+rcon
-=======
+====
 
 .. toctree::
    :maxdepth: 4

docs/source/rcon.battleye.rst

@@ -0,0 +1,29 @@
+rcon.battleye package
+=====================
+
+Submodules
+----------
+
+rcon.battleye.client module
+---------------------------
+
+.. automodule:: rcon.battleye.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcon.battleye.proto module
+--------------------------
+
+.. automodule:: rcon.battleye.proto
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rcon.battleye
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/rcon.rst

@@ -1,16 +1,17 @@
 rcon package
 ============
 
-Submodules
+Subpackages
-----------
+-----------
 
-rcon.asyncio module
+.. toctree::
--------------------
+   :maxdepth: 4
 
-.. automodule:: rcon.asyncio
+   rcon.battleye
-   :members:
+   rcon.source
-   :undoc-members:
+
-   :show-inheritance:
+Submodules
+----------
 
 rcon.client module
 ------------------
@@ -60,14 +61,6 @@ rcon.gui module
    :undoc-members:
    :show-inheritance:
 
-rcon.proto module
------------------
-
-.. automodule:: rcon.proto
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 rcon.rconclt module
 -------------------
 

docs/source/rcon.source.rst

@@ -0,0 +1,37 @@
+rcon.source package
+===================
+
+Submodules
+----------
+
+rcon.source.async\_rcon module
+------------------------------
+
+.. automodule:: rcon.source.async_rcon
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcon.source.client module
+-------------------------
+
+.. automodule:: rcon.source.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rcon.source.proto module
+------------------------
+
+.. automodule:: rcon.source.proto
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: rcon.source
+   :members:
+   :undoc-members:
+   :show-inheritance: