From 6c1a51693957ed491c16259746dd67c6c7c93f8a Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Wed, 8 Jan 2020 09:37:16 -0800 Subject: Initial sphinx documentation --- docs/Makefile | 20 +++++++++++++++++ docs/conf.py | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 22 +++++++++++++++++++ docs/make.bat | 35 ++++++++++++++++++++++++++++++ docs/source/alphanum.rst | 22 +++++++++++++++++++ docs/source/modules.rst | 7 ++++++ 6 files changed, 162 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/source/alphanum.rst create mode 100644 docs/source/modules.rst (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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 = . +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/conf.py b/docs/conf.py new file mode 100644 index 0000000..7d685d9 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,56 @@ +# 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 = 'alphanum' +copyright = '2020, Cody Logan' +author = 'Cody Logan' + +# The full version, including alpha/beta/rc tags +release = '0.2.0.dev1' + + +# -- 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 = [ + 'sphinxcontrib.napoleon' +] + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7c3a505 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. alphanum documentation master file, created by + sphinx-quickstart on Wed Jan 8 09:24:16 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to alphanum's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + source/modules + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..2119f51 --- /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=. +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/alphanum.rst b/docs/source/alphanum.rst new file mode 100644 index 0000000..19cfccc --- /dev/null +++ b/docs/source/alphanum.rst @@ -0,0 +1,22 @@ +alphanum package +================ + +Submodules +---------- + +alphanum.alphanum module +------------------------ + +.. automodule:: alphanum.alphanum + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: alphanum + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..0eae225 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +alphanum +======== + +.. toctree:: + :maxdepth: 4 + + alphanum -- cgit v1.2.3