aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2020-08-05 17:21:45 -0700
committerCody Logan <clpo13@gmail.com>2020-08-05 17:22:41 -0700
commit52e72221bf65d118bc323866243f3fdbd2589c58 (patch)
tree52eda1955e56b2323b6988819cbf4dbc9a3e9136 /docs
parente06712a3618f095dc47df9a39da63f4e916ec35a (diff)
downloadalphanum-52e72221bf65d118bc323866243f3fdbd2589c58.tar.gz
alphanum-52e72221bf65d118bc323866243f3fdbd2589c58.zip
Initialize gh-pages
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile20
-rw-r--r--docs/conf.py69
-rw-r--r--docs/index.rst24
-rw-r--r--docs/make.bat35
-rw-r--r--docs/requirements.txt3
-rw-r--r--docs/source/alphanum.rst22
-rw-r--r--docs/source/modules.rst7
7 files changed, 0 insertions, 180 deletions
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index d4bb2cb..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# 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
deleted file mode 100644
index 40b6d32..0000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,69 +0,0 @@
-# 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'
-
-
-# -- 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 = [
- 'm2r2',
- 'sphinx.ext.autodoc',
- 'sphinx.ext.intersphinx',
- 'sphinx.ext.napoleon',
- 'sphinx.ext.viewcode',
- '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 = ['_build', 'Thumbs.db', '.DS_Store']
-
-intersphinx_mapping = {
- 'python': ('https://docs.python.org/3', None),
-}
-
-napoleon_google_docstring = True
-napoleon_use_param = True
-napoleon_use_ivar = 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']
diff --git a/docs/index.rst b/docs/index.rst
deleted file mode 100644
index 1901192..0000000
--- a/docs/index.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-.. 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!
-====================================
-
-.. mdinclude:: ../README.md
-
-.. 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
deleted file mode 100644
index 2119f51..0000000
--- a/docs/make.bat
+++ /dev/null
@@ -1,35 +0,0 @@
-@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/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index b1f0e5e..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-m2r2
-sphinx
-sphinx_rtd_theme
diff --git a/docs/source/alphanum.rst b/docs/source/alphanum.rst
deleted file mode 100644
index 19cfccc..0000000
--- a/docs/source/alphanum.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-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
deleted file mode 100644
index 0eae225..0000000
--- a/docs/source/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-alphanum
-========
-
-.. toctree::
- :maxdepth: 4
-
- alphanum