From e41d9780a4ee92137a04caefef96f8588a004fc3 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Thu, 27 Aug 2020 17:34:08 +0200 Subject: [PATCH 1/6] Generated default Sphinx config --- docs/Makefile | 20 ++++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++ docs/source/conf.py | 55 +++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 20 ++++++++++++++++ requirements-dev.txt | 1 + 5 files changed, 131 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat 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 0000000..d0c3cbf --- /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 0000000..9534b01 --- /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/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..ec7ed4e --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,55 @@ +# 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('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Frank' +copyright = '2020, Jef Roosens' +author = 'Jef Roosens' + +# The full version, including alpha/beta/rc tags +release = '0.1' + + +# -- 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 = [ +] + +# 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 = 'alabaster' + +# 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'] \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..08aa64f --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. Frank documentation master file, created by + sphinx-quickstart on Thu Aug 27 17:28:57 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Frank's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/requirements-dev.txt b/requirements-dev.txt index 3395ec6..abf950d 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -11,3 +11,4 @@ setuptools~=49.6.0 pytest>=6.0.1,<7.0.0 pytest-asyncio>=0.14.0,<1.0.0 twine>=3.2.0,<4.0.0 +Sphinx==3.2.1 From 9c1a56445b38cf13ab8f55a87a197aceeea2a2dd Mon Sep 17 00:00:00 2001 From: chewingbever Date: Thu, 27 Aug 2020 18:18:27 +0200 Subject: [PATCH 2/6] Docs now auto-generate from docstrings --- .gitignore | 4 +++- Makefile | 4 ++-- docs/source/conf.py | 9 +++++---- docs/source/index.rst | 5 ----- frank/modules/help.py | 2 +- 5 files changed, 11 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index a65b273..b4bfba1 100644 --- a/.gitignore +++ b/.gitignore @@ -8,8 +8,10 @@ build/ *.egg-info/ *.eggs/ -# Docs output +# Docs docs/build +docs/source/*.rst +!docs/source/index.rst # Caches __pycache__/ diff --git a/Makefile b/Makefile index 2f30a78..a7e6a75 100644 --- a/Makefile +++ b/Makefile @@ -47,8 +47,8 @@ clean-setup: @ find . -maxdepth 1 -type d -name '*.egg-info' -exec rm -rf "{}" \; # =====DOCS===== -docs: build-venv - @ "$(VENV)/bin/sphinx-apidoc" -o "$(DOCS)/source" "$(SRC)" +docs: build-venv docs/source/conf.py docs/source/index.rst + @ "$(VENV)/bin/sphinx-apidoc" -f -o "$(DOCS)/source" "$(SRC)" @ "$(VENV)/bin/sphinx-build" "$(DOCS)/source" "$(DOCS)/build" diff --git a/docs/source/conf.py b/docs/source/conf.py index ec7ed4e..386c386 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,9 +10,9 @@ # 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 os +import sys +sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- @@ -31,6 +31,7 @@ release = '0.1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.napoleon', ] # Add any paths that contain templates here, relative to this directory. @@ -52,4 +53,4 @@ html_theme = 'alabaster' # 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'] \ No newline at end of file +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst index 08aa64f..b2bd4a0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,8 +1,3 @@ -.. Frank documentation master file, created by - sphinx-quickstart on Thu Aug 27 17:28:57 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to Frank's documentation! ================================= diff --git a/frank/modules/help.py b/frank/modules/help.py index b8a6c61..fa08f33 100644 --- a/frank/modules/help.py +++ b/frank/modules/help.py @@ -37,7 +37,7 @@ class HelpMod(Module): await channel.send(embed=embed) - @regex_command(cmd='.+', help_str='Show help about a certain module.') + @regex_command(pattern='.+', help_str='Show help about a certain module.') async def show_module_help(self, prefix: str, cmd: List[str], author: User, channel: Messageable, mid: int): # Yes, this command just ignores cmd at the moment From 6f0af5dfdfe6fb2350e945caa88a135cf653b712 Mon Sep 17 00:00:00 2001 From: chewingbever Date: Thu, 27 Aug 2020 18:30:56 +0200 Subject: [PATCH 3/6] Switched to Read The Docs theme --- docs/source/conf.py | 3 ++- frank/module/decorators/classes.py | 2 +- requirements-dev.txt | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 386c386..9a8dc9b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -32,6 +32,7 @@ release = '0.1' # ones. extensions = [ 'sphinx.ext.napoleon', + 'sphinx_rtd_theme', ] # Add any paths that contain templates here, relative to this directory. @@ -48,7 +49,7 @@ exclude_patterns = [] # 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/frank/module/decorators/classes.py b/frank/module/decorators/classes.py index 3e93be1..d14e398 100644 --- a/frank/module/decorators/classes.py +++ b/frank/module/decorators/classes.py @@ -87,7 +87,7 @@ class RegexCommand(Command): Args: prefix: string to match pattern against; Pattern must match entire - prefix + prefix """ return bool(re.fullmatch(self.cmd, prefix)) diff --git a/requirements-dev.txt b/requirements-dev.txt index abf950d..5059612 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -12,3 +12,4 @@ pytest>=6.0.1,<7.0.0 pytest-asyncio>=0.14.0,<1.0.0 twine>=3.2.0,<4.0.0 Sphinx==3.2.1 +sphinx-rtd-theme==0.5.0 From 75be358ff69f83fca740acb082c3dc8071b174ac Mon Sep 17 00:00:00 2001 From: chewingbever Date: Thu, 27 Aug 2020 18:40:54 +0200 Subject: [PATCH 4/6] apidoc now has its own directory --- .gitignore | 3 +-- Makefile | 2 +- docs/source/conf.py | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index b4bfba1..b20fe45 100644 --- a/.gitignore +++ b/.gitignore @@ -10,8 +10,7 @@ build/ # Docs docs/build -docs/source/*.rst -!docs/source/index.rst +docs/source/apidoc/ # Caches __pycache__/ diff --git a/Makefile b/Makefile index a7e6a75..423af24 100644 --- a/Makefile +++ b/Makefile @@ -48,7 +48,7 @@ clean-setup: # =====DOCS===== docs: build-venv docs/source/conf.py docs/source/index.rst - @ "$(VENV)/bin/sphinx-apidoc" -f -o "$(DOCS)/source" "$(SRC)" + @ "$(VENV)/bin/sphinx-apidoc" -f -o "$(DOCS)/source/apidoc" "$(SRC)" @ "$(VENV)/bin/sphinx-build" "$(DOCS)/source" "$(DOCS)/build" diff --git a/docs/source/conf.py b/docs/source/conf.py index 9a8dc9b..e31b07d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,8 +18,8 @@ sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- project = 'Frank' -copyright = '2020, Jef Roosens' author = 'Jef Roosens' +copyright = f'2020, {author}' # noqa: A001,VNE003 # The full version, including alpha/beta/rc tags release = '0.1' From 3c7259ce08f55c9791caccdb4735e8db5d62953c Mon Sep 17 00:00:00 2001 From: chewingbever Date: Fri, 28 Aug 2020 09:38:04 +0200 Subject: [PATCH 5/6] Added install instructions --- docs/source/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index b2bd4a0..902759e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,7 +5,12 @@ Welcome to Frank's documentation! :maxdepth: 2 :caption: Contents: +Installation +============ +You can install Frank using pip:: + + pip install frank-discord Indices and tables ================== From 346f39f243a3ef39d276612f10e0f96c8d399dfc Mon Sep 17 00:00:00 2001 From: chewingbever Date: Fri, 28 Aug 2020 12:00:21 +0200 Subject: [PATCH 6/6] Tidied up Makefile --- Makefile | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 423af24..56d16ab 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ INTERPRETER=python3.8 all: run -# Re-create venv when needed +# =====VENV===== $(VENV)/bin/activate: requirements.txt requirements-dev.txt @ echo "Rebuilding venv..." @ [ ! -e "$(VENV)" ] || rm -rf "$(VENV)" @@ -22,8 +22,9 @@ $(VENV)/bin/activate: requirements.txt requirements-dev.txt build-venv: $(VENV)/bin/activate + # =====CLEANING===== -clean: clean-venv clean-cache clean-docs +clean: clean-venv clean-cache clean-docs clean-setup # Remove venv clean-venv: @@ -46,8 +47,9 @@ clean-setup: @ [ ! -e "build" ] || rm -rf build @ find . -maxdepth 1 -type d -name '*.egg-info' -exec rm -rf "{}" \; + # =====DOCS===== -docs: build-venv docs/source/conf.py docs/source/index.rst +docs: docs/source/conf.py docs/source/index.rst build-venv @ "$(VENV)/bin/sphinx-apidoc" -f -o "$(DOCS)/source/apidoc" "$(SRC)" @ "$(VENV)/bin/sphinx-build" "$(DOCS)/source" "$(DOCS)/build"