1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 19:44:20 +00:00

Start work on some docs

This commit is contained in:
Steffo 2019-04-23 17:10:43 +02:00
parent e300926f4c
commit b6b8c63f88
10 changed files with 66 additions and 11 deletions

1
.gitignore vendored
View file

@ -8,3 +8,4 @@ markovmodels/
logs/ logs/
royalnet.egg-info/ royalnet.egg-info/
.pytest_cache/ .pytest_cache/
docs/_build/*

9
docs/audio.rst Normal file
View file

@ -0,0 +1,9 @@
royalnet.audio
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.audio
:members:

8
docs/bots.rst Normal file
View file

@ -0,0 +1,8 @@
royalnet.bots
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.bots
:members:

9
docs/commands.rst Normal file
View file

@ -0,0 +1,9 @@
royalnet.commands
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.commands
:members:

View file

@ -27,8 +27,7 @@ author = 'Stefano Pigozzi'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = ["sphinx.ext.autodoc"]
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] 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 # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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, # 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, # relative to this directory. They are copied after the builtin static files,

9
docs/database.rst Normal file
View file

@ -0,0 +1,9 @@
royalnet.database
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.database
:members:

View file

@ -1,15 +1,15 @@
.. Royalnet documentation master file, created by royalnet
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!
==================================== ====================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents:
audio
bots
commands
database
network
utils
Indices and tables Indices and tables
@ -17,4 +17,4 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`

9
docs/network.rst Normal file
View file

@ -0,0 +1,9 @@
royalnet.network
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.network
:members:

9
docs/utils.rst Normal file
View file

@ -0,0 +1,9 @@
royalnet.utils
====================================
.. toctree::
:maxdepth: 2
.. automodule:: royalnet.utils
:members:

View file

@ -9,3 +9,5 @@ dateparser>=0.7.1
discord.py>=1.0.1 discord.py>=1.0.1
youtube_dl>=2019.4.7 youtube_dl>=2019.4.7
ffmpeg-python>=0.1.17 ffmpeg-python>=0.1.17
Sphinx>=2.0.1
sphinx_rtd_theme>=0.4.3