read the docs doc

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

Changelog.md

@@ -1,9 +1,17 @@
 ===
-tabulato **`1.0.3`**
+tabulato **`1.0.4`**
 ===
 
 ### Release Notes - `tabulato`
 
+We have release the new `tabulato` Version `1.0.4` (`2024-04-09`)
+
+##### Changes
+
+- Updated documentation.
+
+### Release Notes - `tabulato`
+
 We have release the new `tabulato` Version `1.0.3` (`2024-03-07`)
 
 ##### Changes

README.md

@@ -29,7 +29,7 @@ With `tabulato`, you can easily format your data into tables with specified head
 - Option to make headers bold for emphasis.
 - User-friendly API for straightforward integration into your Python projects.
 
-> tabulato simplifies the task of formatting and presenting tabular data in terminal environments, making it an essential tool for developers and data scientists working with command-line interfaces.
+> `tabulato` simplifies the task of formatting and presenting tabular data in terminal environments, making it an essential tool for developers and data scientists working with command-line interfaces.
 
 ### Installation
 

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
+
+%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
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+# Defining the exact version will make sure things don't break
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1
+readthedocs-sphinx-search==0.1.1

docs/source/_static/css/index.css

@@ -0,0 +1,3 @@
+table.my-table td {
+  white-space: normal !important;
+}

docs/source/conf.py

@@ -0,0 +1,57 @@
+# 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 = "tabulato"
+copyright = "2024, Crispen Gari"
+author = "Crispen Gari"
+
+
+# -- 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 = "sphinx_rtd_theme"
+highlight_language = "python"
+
+# 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"]
+
+
+html_css_files = [
+    "css/index.css",
+]

docs/source/features.rst

@@ -0,0 +1,11 @@
+Features
+++++++++
+
+**Key features of tabulato include**
+
+- Generating tables with customizable colors for headers, even rows, and odd rows.
+- Specifying required columns to ensure important data is always displayed.
+- Option to make headers bold for emphasis.
+- User-friendly API for straightforward integration into your Python projects.
+
+> ``tabulato`` simplifies the task of formatting and presenting tabular data in terminal environments, making it an essential tool for developers and data scientists working with command-line interfaces.

docs/source/github/contribution.rst

@@ -0,0 +1,5 @@
+
+Contributing
+++++++++++++
+
+To contribute to ``tabulato`` open a pull request on `GitHub <https://github.com/CrispenGari/tabulato>`_ file.

docs/source/github/license.rst

@@ -0,0 +1,4 @@
+License
++++++++
+
+This project is licensed under the ``MIT`` License - see the `LICENSE <https://github.com/CrispenGari/tabulato/blob/main/LICENSE>`_  file for details.

docs/source/index.rst

@@ -0,0 +1,47 @@
+.. tabulato documentation master file, created by
+   sphinx-quickstart on Tue Apr  9 07:38:42 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ``tabulato's`` documentation!
+========================================
+
+``tabulato`` is a Python package that provides functionality for generating tabulated representations of data with customizable colors and formatting options. It offers a user-friendly interface for creating visually appealing tables in terminal output.
+
+With ``tabulato``, you can easily format your data into tables with specified headers, apply different colors to headers and rows, and customize the appearance of your tabulated data. Whether you're working on command-line applications, data analysis scripts, or any other project that requires presenting data in a tabular format, ``tabulato`` can help streamline the process and enhance the visual presentation of your data.
+
+.. raw:: html
+
+   <p align="center">
+      <a href="https://pypi.python.org/pypi/tabulato"><img src="https://badge.fury.io/py/tabulato.svg"></a>
+      <a href="https://github.com/crispengari/tabulato/actions/workflows/ci.yml"><img src="https://github.com/crispengari/tabulato/actions/workflows/ci.yml/badge.svg"></a>
+      <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green"></a>
+      <a href="https://pypi.python.org/pypi/tabulato"><img src="https://img.shields.io/pypi/pyversions/tabulato.svg"></a>
+   </p>
+
+**What's missing on this package?**
+
+This package lacks ``wrapping`` of text for long lines. This ``version`` only support small tables. Long column data might not end up displayed well, however with small column data like this package is the best.
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Getting Started
+
+   installation
+   usage
+   features
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: GitHub and Contribution
+
+   github/contribution
+   github/license
+
+
+
+
+
+

docs/source/installation.rst

@@ -0,0 +1,16 @@
+
+Installation
+++++++++++++
+
+To install ``tabulato``, you can use pip:
+
+.. code-block:: shell
+
+    pip install tabulato
+
+**Python Version**
+
+This package support python version ``>=3.10``
+
+
+Once you install ``tabulato`` now you are ready to use it in your projects.