From 1f374c63eb2700cb3ec1ba0cbc00aa7a0dfdbf04 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Sat, 17 Apr 2021 17:22:04 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Update=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Makefile | 20 +++++++ docs/make.bat | 35 +++++++++++ docs/source/_static/royalblue.css | 3 + docs/source/autodoc/index.rst | 8 +++ docs/source/conf.py | 99 +++++++++++++++++++++++++++++++ docs/source/index.rst | 33 +++++++++++ 6 files changed, 198 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/_static/royalblue.css create mode 100644 docs/source/autodoc/index.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..9534b018 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + 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/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/_static/royalblue.css b/docs/source/_static/royalblue.css new file mode 100644 index 00000000..d98fc068 --- /dev/null +++ b/docs/source/_static/royalblue.css @@ -0,0 +1,3 @@ +.wy-side-nav-search, .wy-nav-top { + background-color: #0d193b !important; +} diff --git a/docs/source/autodoc/index.rst b/docs/source/autodoc/index.rst new file mode 100644 index 00000000..b6c44559 --- /dev/null +++ b/docs/source/autodoc/index.rst @@ -0,0 +1,8 @@ +Autogenerated documentation +=========================== + +Welcome to the autogenerated documentation of Royalnet Telethon! + +It may be incomplete or outdated, as it is automatically updated. + +.. automodule:: royalnet_telethon diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..ff572072 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,99 @@ +# 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('.')) + +import pkg_resources + +# -- Project information ----------------------------------------------------- + +project = 'royalnet_telethon' +# noinspection PyShadowingBuiltins +copyright = '2021, Stefano Pigozzi' +author = 'Stefano Pigozzi' + +# The full version, including alpha/beta/rc tags +release = pkg_resources.get_distribution("royalnet_telethon").version + + +# -- 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", + "sphinx.ext.intersphinx", + 'sphinx.ext.todo', +] + +# 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 = ['Thumbs.db', '.DS_Store'] + +# Print warnings on the page +keep_warnings = True + +# Display more warnings than usual +nitpicky = True + +# -- 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' + +# 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'] + + +# -- Intersphinx options ----------------------------------------------------- + +intersphinx_mapping = { + "python": ("https://docs.python.org/3.8", None), + "royalnet": ("https://royalnet-6.readthedocs.io/en/latest", None) +} + + +# -- Setup function ---------------------------------------------------------- +def setup(app): + app.add_css_file('royalblue.css') + + +# -- Substitutions ----------------------------------------------------------- + + +rst_prolog = """ + +""" + +# -- Automodule settings ----------------------------------------------------- + +autodoc_default_options = { + 'members': True, + 'member-order': 'bysource', + 'special-members': '__init__', + 'undoc-members': True, +} + +# -- Automodule settings ----------------------------------------------------- + +todo_include_todos = True diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..b7b4e34a --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,33 @@ +Royalnet Telethon +================ + +Welcome to the documentation of Royalnet Telethon! + + +Table of contents +----------------- + +.. toctree:: + :maxdepth: 2 + + autodoc/index + + +Useful links +------------ + +* `Royalnet Telethon on GitHub `_ +* `Documentation of Royalnet `_ + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +To do +----- + +.. todolist::