From b6b8c63f887701b4b29c167b7c475fe8f3b4bd9a Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Tue, 23 Apr 2019 17:10:43 +0200 Subject: [PATCH] Start work on some docs --- .gitignore | 1 + docs/audio.rst | 9 +++++++++ docs/bots.rst | 8 ++++++++ docs/commands.rst | 9 +++++++++ docs/conf.py | 5 ++--- docs/database.rst | 9 +++++++++ docs/index.rst | 16 ++++++++-------- docs/network.rst | 9 +++++++++ docs/utils.rst | 9 +++++++++ requirements.txt | 2 ++ 10 files changed, 66 insertions(+), 11 deletions(-) create mode 100644 docs/audio.rst create mode 100644 docs/bots.rst create mode 100644 docs/commands.rst create mode 100644 docs/database.rst create mode 100644 docs/network.rst create mode 100644 docs/utils.rst diff --git a/.gitignore b/.gitignore index b0f5ad08..2f54e4fd 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ markovmodels/ logs/ royalnet.egg-info/ .pytest_cache/ +docs/_build/* diff --git a/docs/audio.rst b/docs/audio.rst new file mode 100644 index 00000000..f05f8cf1 --- /dev/null +++ b/docs/audio.rst @@ -0,0 +1,9 @@ +royalnet.audio +==================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: royalnet.audio + :members: diff --git a/docs/bots.rst b/docs/bots.rst new file mode 100644 index 00000000..a3392a7a --- /dev/null +++ b/docs/bots.rst @@ -0,0 +1,8 @@ +royalnet.bots +==================================== + +.. toctree:: + :maxdepth: 2 + +.. automodule:: royalnet.bots + :members: diff --git a/docs/commands.rst b/docs/commands.rst new file mode 100644 index 00000000..62043493 --- /dev/null +++ b/docs/commands.rst @@ -0,0 +1,9 @@ +royalnet.commands +==================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: royalnet.commands + :members: diff --git a/docs/conf.py b/docs/conf.py index 8d63ffb5..81205bd6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,8 +27,7 @@ author = 'Stefano Pigozzi' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ -] +extensions = ["sphinx.ext.autodoc"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -44,7 +43,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # 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, diff --git a/docs/database.rst b/docs/database.rst new file mode 100644 index 00000000..23dd02a4 --- /dev/null +++ b/docs/database.rst @@ -0,0 +1,9 @@ +royalnet.database +==================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: royalnet.database + :members: diff --git a/docs/index.rst b/docs/index.rst index ad2fa23b..7511c0dc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,15 @@ -.. Royalnet documentation master file, created by - sphinx-quickstart on Sat Apr 20 18:08:14 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Royalnet's documentation! +royalnet ==================================== .. toctree:: :maxdepth: 2 - :caption: Contents: + audio + bots + commands + database + network + utils Indices and tables @@ -17,4 +17,4 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` -* :ref:`search` +* :ref:`search` \ No newline at end of file diff --git a/docs/network.rst b/docs/network.rst new file mode 100644 index 00000000..cc5b52f4 --- /dev/null +++ b/docs/network.rst @@ -0,0 +1,9 @@ +royalnet.network +==================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: royalnet.network + :members: diff --git a/docs/utils.rst b/docs/utils.rst new file mode 100644 index 00000000..9d098917 --- /dev/null +++ b/docs/utils.rst @@ -0,0 +1,9 @@ +royalnet.utils +==================================== + +.. toctree:: + :maxdepth: 2 + + +.. automodule:: royalnet.utils + :members: diff --git a/requirements.txt b/requirements.txt index 4e0471a2..be6b2313 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,3 +9,5 @@ dateparser>=0.7.1 discord.py>=1.0.1 youtube_dl>=2019.4.7 ffmpeg-python>=0.1.17 +Sphinx>=2.0.1 +sphinx_rtd_theme>=0.4.3