From f16f33ea8a27a9c0e5b030976f789dc2b9702da4 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 2 Dec 2019 23:45:34 +0000 Subject: [PATCH] Initial commit of Houdini docs --- docs/Makefile | 20 +++++++ docs/make.bat | 35 +++++++++++++ docs/source/conf.py | 52 +++++++++++++++++++ docs/source/index.rst | 18 +++++++ docs/source/intro/getting-started.md | 12 +++++ .../source/plugins/introduction.md | 14 ++++- 6 files changed, 150 insertions(+), 1 deletion(-) 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 create mode 100644 docs/source/intro/getting-started.md rename houdini/plugins/example/__init__.py => docs/source/plugins/introduction.md (77%) 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..6247f7e --- /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..586ce36 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,52 @@ +# 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 = 'Houdini' +copyright = '2019, Ben' +author = 'Ben' + + +# -- 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..3631de8 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,18 @@ +Welcome to Houdini's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + intro/getting-started + plugins/introduction + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/intro/getting-started.md b/docs/source/intro/getting-started.md new file mode 100644 index 0000000..39d07a1 --- /dev/null +++ b/docs/source/intro/getting-started.md @@ -0,0 +1,12 @@ +# Getting started with Houdini + +Houdini can be installed like any other Python program: + +```py +git clone https://github.com/solero/houdini-asyncio +cd houdini-asyncio +pip install -r requirements.txt +python bootstrap.py login +``` + +This page is a WIP! \ No newline at end of file diff --git a/houdini/plugins/example/__init__.py b/docs/source/plugins/introduction.md similarity index 77% rename from houdini/plugins/example/__init__.py rename to docs/source/plugins/introduction.md index 6df6a86..df0ba44 100644 --- a/houdini/plugins/example/__init__.py +++ b/docs/source/plugins/introduction.md @@ -1,3 +1,8 @@ +# Plugins: An introduction + +Plugins provide a neat way to extend Houdini's functionality. Here is an example! + +```python from houdini import handlers from houdini.handlers import XTPacket @@ -6,7 +11,6 @@ from houdini import commands from houdini import permissions - class Example(IPlugin): author = "Ben" description = "Example plugin for developers" @@ -31,3 +35,11 @@ class Example(IPlugin): @permissions.has('houdini.ping') async def ping(self, p): await p.send_xt('cprompt', 'Pong') + + @commands.command('ac') + async def add_coins(self, p, amount: int = 100): + await p.add_coins(amount, stay=True) + +``` + +This page is a WIP! \ No newline at end of file