Update docs for rtd and switch generate style list to rst

Author: DenverCoder1

.gitignore

@@ -70,6 +70,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+generated
+docs/source/_build/
 
 # PyBuilder
 target/

docs/source/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)

docs/source/api.rst

@@ -1,39 +1,28 @@
-API
-===
+.. currentmodule:: table2ascii
 
-.. autosummary::
-   :toctree: generated
+API Reference
+=============
 
-   table2ascii
-
-TableToAscii
-~~~~~~~~~~~~~
+table2ascii
+~~~~~~~~~~~
 
-.. attributetable:: TableToAscii
+.. autofunction:: table2ascii
 
-.. autoclass:: TableToAscii
-    :members:
 
 Alignment
-~~~~~~~~~~
-
-.. attributetable:: Alignment
+~~~~~~~~~
 
-.. autoclass:: Alignment
+.. autoenum:: Alignment
     :members:
 
-TableStyle
+PresetStyle
 ~~~~~~~~~~~
 
-.. attributetable:: TableStyle
-
-.. autoclass:: TableStyle
+.. autoclass:: PresetStyle
     :members:
 
-PresetStyle
-~~~~~~~~~~~~
-
-.. attributetable:: PresetStyle
+TableStyle
+~~~~~~~~~~
 
-.. autoclass:: PresetStyle
-    :members:
+.. autoclass:: TableStyle
+    :members:

docs/source/conf.py

@@ -1,35 +1,62 @@
 # 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
 
-# -- Project information
+# -- Path setup --------------------------------------------------------------
 
-project = 'table2ascii'
-copyright = '2021, Jonah Lawrence'
-author = 'Jonah Lawrence'
+# 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
 
-release = '0.1.2'
-version = '0.1.2'
+sys.path.insert(0, os.path.abspath("."))
+sys.path.append(os.path.abspath("extensions"))
 
-# -- General configuration
 
+# -- Project information -----------------------------------------------------
+
+project = "table2ascii"
+copyright = "2021, Jonah Lawrence"
+author = "Jonah Lawrence"
+
+
+# -- 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.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "enum_tools.autoenum",
 ]
 
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-}
-intersphinx_disabled_domains = ['std']
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
 
-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
 
-html_theme = 'sphinx_rtd_theme'
+# 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"]
 
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = "footnote"

docs/source/index.rst

@@ -21,6 +21,7 @@ Contents
 
    usage
    api
+   styles
 
 
 .. |build| image:: https://img.shields.io/github/workflow/status/DenverCoder1/table2ascii/Python%20application/main

docs/source/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.https://www.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