Merge branch 'sphinx-config' into develop

.gitignore

@@ -8,8 +8,9 @@ build/
 *.egg-info/
 *.eggs/
 
-# Docs output
+# Docs
 docs/build
+docs/source/apidoc/
 
 # Caches
 __pycache__/

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,9 +47,10 @@ clean-setup:
 	@ [ ! -e "build" ] || rm -rf build
 	@ find . -maxdepth 1 -type d -name '*.egg-info' -exec rm -rf "{}" \;
 
+
 # =====DOCS=====
-docs: build-venv
-	@ "$(VENV)/bin/sphinx-apidoc" -o "$(DOCS)/source" "$(SRC)"
+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"
 
 

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)

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

docs/source/conf.py

@@ -0,0 +1,57 @@
+# 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'
+author = 'Jef Roosens'
+copyright = f'2020, {author}'  # noqa: A001,VNE003
+
+# 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 = [
+    'sphinx.ext.napoleon',
+    'sphinx_rtd_theme',
+]
+
+# 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'
+
+# 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']

docs/source/index.rst

@@ -0,0 +1,20 @@
+Welcome to Frank's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Installation
+============
+
+You can install Frank using pip::
+
+    pip install frank-discord
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

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

requirements-dev.txt

@@ -11,3 +11,5 @@ 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
+sphinx-rtd-theme==0.5.0