Merge pull request #18 from DenverCoder1/docs

Author: DenverCoder1

.gitignore

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

.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+formats: []
+
+build:
+  image: latest
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+  builder: html
+
+python:
+  version: "3.8"
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -4,33 +4,18 @@
 [![version](https://img.shields.io/pypi/v/table2ascii)](https://pypi.org/project/table2ascii/)
 [![downloads](https://static.pepy.tech/personalized-badge/table2ascii?period=total&units=none&left_color=grey&right_color=orange&left_text=downloads)](https://pepy.tech/project/table2ascii)
 [![license](https://img.shields.io/pypi/l/table2ascii)](https://github.com/DenverCoder1/table2ascii/blob/main/LICENSE)
-[![Discord](https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white "Dev Pro Tips Discussion & Support Server")](https://discord.gg/fPrdqh3Zfu)
-
-Module for converting 2D Python lists to fancy ASCII/Unicode tables
-
-- [table2ascii](#table2ascii)
-  - [📥 Installation](#-installation)
-  - [🧑‍💻 Usage](#-usage)
-    - [Convert lists to ASCII tables](#convert-lists-to-ascii-tables)
-    - [Set first or last column headings](#set-first-or-last-column-headings)
-    - [Set column widths and alignments](#set-column-widths-and-alignments)
-    - [Use a preset style](#use-a-preset-style)
-    - [Define a custom style](#define-a-custom-style)
-  - [🎨 Preset styles](#-preset-styles)
-  - [⚙️ Options](#️-options)
-  - [👨‍🎨 Use cases](#-use-cases)
-    - [Discord messages and embeds](#discord-messages-and-embeds)
-    - [Terminal outputs](#terminal-outputs)
-  - [🧰 Development](#-development)
+[![discord](https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white "Dev Pro Tips Discussion & Support Server")](https://discord.gg/fPrdqh3Zfu)
+
+Library for converting 2D Python lists to fancy ASCII/Unicode tables
+
+Documentation and examples are available at [table2ascii.rtfd.io](https://table2ascii.readthedocs.io/)
 
 ## 📥 Installation
 
-``pip install table2ascii`` 
+``pip install -U table2ascii`` 
 
 **Requirements:** `Python 3.7+`
 
-(For Python 3.6, installing `dataclasses` is required)
-
 ## 🧑‍💻 Usage
 
 ### Convert lists to ASCII tables
@@ -158,7 +143,7 @@ print(output)
 
 ## 🎨 Preset styles
 
-See a list of all preset styles [here](https://github.com/DenverCoder1/table2ascii/tree/main/style_list).
+See a list of all preset styles [here](https://table2ascii.readthedocs.io/en/latest/styles.html).
 
 ## ⚙️ Options
 
@@ -193,10 +178,16 @@ All parameters are optional.
 
 ## 🧰 Development
 
-To run tests (pytest)
+### Running tests
 
-``tox``
+1. Install `tox` with the command ``pip install -U tox``
 
-To lint (flake8):
+2. Run tests with the command ``tox``
+
+### Linting
+
+Run the following command to lint with flake8
 
 ``python setup.py lint``
+
+(Note: The exact command may vary depending on your Python version and environment)

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/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/_static/css/badge_only.css

@@ -0,0 +1,18 @@
+.wy-side-nav-search > a {
+    font-size: 160%;
+}
+
+.wy-side-nav-search input[type="text"] {
+    padding: 10px 15px;
+    font-size: 100%;
+    border-radius: 10px;
+}
+
+.section a:visited,
+footer a:visited {
+    color: #2980b9;
+}
+
+a.icon.icon-home:visited {
+    color: unset;
+}