diff --git a/docs/make.bat b/docs/make.bat index 6247f7e..747ffb7 100644 --- a/docs/make.bat +++ b/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 diff --git a/docs/source/conf.py b/docs/source/conf.py index d4c2ba6..8c0a9db 100644 --- a/docs/source/conf.py +++ b/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 -# list see the documentation: +# For the full list of built-in configuration values, 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' - -# The full version, including alpha/beta/rc tags -release = '1.0.0' - +release = '2.3.6' # -- 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 coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx_rtd_theme', - 'sphinx.ext.autodoc' -] +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 = 'sphinx_rtd_theme' +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# 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_theme = 'alabaster' html_static_path = ['_static'] diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 4db0e26..b28b3a6 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,5 +1,5 @@ -Modules -======= +rcon +==== .. toctree:: :maxdepth: 4 diff --git a/docs/source/rcon.battleye.rst b/docs/source/rcon.battleye.rst new file mode 100644 index 0000000..09d8f0f --- /dev/null +++ b/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: diff --git a/docs/source/rcon.rst b/docs/source/rcon.rst index 367998a..3d06906 100644 --- a/docs/source/rcon.rst +++ b/docs/source/rcon.rst @@ -1,16 +1,17 @@ rcon package ============ -Submodules ----------- +Subpackages +----------- -rcon.asyncio module -------------------- +.. toctree:: + :maxdepth: 4 -.. automodule:: rcon.asyncio - :members: - :undoc-members: - :show-inheritance: + rcon.battleye + rcon.source + +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 ------------------- diff --git a/docs/source/rcon.source.rst b/docs/source/rcon.source.rst new file mode 100644 index 0000000..3e20a58 --- /dev/null +++ b/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: