✨📜 add default template for rtd, sphinx docs generator

ZenithClown · ZenithClown · commit ba6922bbfe16 · 2025-05-13T17:20:35.000+05:30
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+submodules:
+  include: all
+  recursive: true
+
+python:
+  install:
+    - requirements: docs/requirements-doc.txt
+
+sphinx:
+  fail_on_warning: false
+  configuration: docs/conf.py
diff --git a/docs/Makefile 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
@@ -0,0 +1,43 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+PKG = "pkg-name" # Edit with your package name
+
+# ? insert the project paths to let sphinx recognize/find packages
+sys.path.append(os.path.abspath(os.path.join("..")))
+
+project = "Package Name"
+copyright = "2021, Debmalya Pramanik"
+author = "Debmalya Pramanik"
+release = open(os.path.abspath(os.path.join("..", PKG, "VERSION")), "r").read()
+
+# import all working modules for autodoc features
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'myst_parser',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+# html_logo = 'assets/images/logo.jpg'
+html_favicon = 'assets/images/favicon/favicon.ico'
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,55 @@
+<div align = "center">
+
+# DS Documentation Vault
+
+[![Zenith Clown](https://img.shields.io/badge/🧠-Debmalya_Pramanik-blue)](https://zenithclown.github.io/)
+[![REPO:ADMIN](https://img.shields.io/badge/GitHub-ZenithClown-2A8542?logo=github)](https://github.com/ZenithClown)
+[![REPO:ADMIN](https://img.shields.io/badge/GitLab-ZenithClown-2A8542?logo=gitlab)](https://gitlab.com/ZenithClown)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-dPramanik-blue?logo=linkedin)](https://www.linkedin.com/in/dpramanik/)
+
+[![Documentation Status](https://readthedocs.org/projects/ds-gringotts/badge/?version=latest)](https://ds-gringotts.readthedocs.io/en/latest/?badge=latest)
+[![Dependabot Updates](https://github.com/code-archived/ds-gringotts/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/code-archived/ds-gringotts/actions/workflows/dependabot/dependabot-updates)
+
+✨ *Some Extraordinary Project Tag Line* ✨
+
+</div>
+
+<div align = "justify">
+
+```{toctree}
+:maxdepth: 2
+:hidden:
+:caption: Getting Started
+
+./about/objective.md
+./about/installation.md
+```
+
+Welcome to the template repository. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam pharetra quam non nisl semper bibendum. Nulla bibendum pulvinar sapien sit amet rutrum. Nulla tempus vel leo et lobortis. Aliquam a suscipit neque. Quisque lorem sapien, faucibus non mollis at, consequat eget risus. Phasellus vel risus a eros rutrum venenatis et a nisi. Etiam vestibulum auctor lacus, nec blandit lacus molestie sed. Interdum et malesuada fames ac ante ipsum primis in faucibus. Morbi porta semper metus, sed viverra nunc aliquet id. Quisque rutrum blandit enim vitae laoreet. Suspendisse potenti. Nullam a velit metus. Sed laoreet ligula id vestibulum volutpat. Aliquam pellentesque venenatis augue, suscipit imperdiet ipsum bibendum blandit. Curabitur ac porta justo, quis porta massa.
+
+Nam et dui scelerisque, consequat arcu vitae, congue dui. Nam in vestibulum ligula, sit amet suscipit tellus. Fusce eget massa at arcu gravida porta. Suspendisse metus felis, consectetur eget sagittis ac, faucibus vel enim. In turpis justo, vestibulum at accumsan fermentum, accumsan et mi. Ut in consequat libero. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Cras lacinia ligula a odio congue convallis. Cras commodo dui vitae felis sagittis, vel rutrum elit accumsan. Fusce at maximus purus, id aliquet tortor. Vestibulum tincidunt ornare congue. Integer facilisis pharetra nisl, quis tincidunt purus viverra sed. Integer tincidunt justo sem, quis rhoncus ante gravida feugiat. Etiam ac velit dui.
+
+Sed sodales est placerat augue iaculis posuere. Etiam imperdiet nulla quam, id auctor est egestas non. Quisque orci nibh, rhoncus a velit sed, consequat iaculis velit. Quisque et quam ut metus fermentum rhoncus. Nulla molestie lorem eu mauris placerat dapibus. Cras consectetur ante ipsum, dapibus vulputate tortor ullamcorper et. Pellentesque non quam vel leo aliquet condimentum. Nulla suscipit tortor nisi, non molestie velit vestibulum quis. Donec diam ligula, placerat at nibh vitae, fermentum sodales leo. Sed sollicitudin tellus vel nulla tempus, sed consequat augue egestas. Nulla vel ex at orci ultricies tincidunt. Quisque molestie odio ac malesuada congue. Sed mollis mattis consectetur. Fusce at porttitor est. Vivamus arcu velit, rhoncus sit amet ante ac, interdum porttitor justo. Vestibulum non lacinia felis, non mattis felis.
+
+Nulla porta eu nisl pellentesque luctus. Ut at mauris quam. Morbi tortor elit, viverra non tortor quis, aliquam molestie ex. Vestibulum condimentum lorem justo, quis vulputate turpis venenatis varius. Suspendisse nisi tortor, lacinia id volutpat facilisis, finibus vitae tellus. Suspendisse potenti. Donec nec est nec felis convallis lobortis vel et tortor. Quisque ut gravida nunc, ac varius urna. Cras nec dolor eu dolor pulvinar bibendum vel eget sem. Morbi vehicula dapibus dictum. Aenean volutpat magna id efficitur accumsan. Ut pretium, enim vel euismod ornare, nibh est tincidunt nisl, sed dictum enim dolor ac massa. Quisque finibus ornare ante et dictum.
+
+Duis condimentum iaculis ex, vitae facilisis tortor pretium non. Nullam ultrices, velit vitae viverra gravida, eros justo finibus libero, eu congue sem dui id metus. Etiam sollicitudin, velit at pellentesque consectetur, quam libero fringilla orci, eu mattis nulla odio eu justo. Donec at enim et mi molestie tempor. Morbi lobortis consectetur sapien interdum tincidunt. Etiam in ultricies ipsum, ac pretium est. Maecenas ullamcorper enim risus, id porta lacus finibus suscipit. Mauris ut nulla a arcu rhoncus scelerisque eget in orci. Proin porttitor eu arcu vitae ultricies.
+
+## Motivation & Design
+
+Designing and maintaining functions and their documentation is a tedious task, and to somewhat automate the same and auto-update
+the documents to the latest version - I've selected [sphinx](https://www.sphinx-doc.org/en/master/) and
+[ReadTheDocs](https://docs.readthedocs.io/en/stable/) to host and document the same.
+
+## Contributing Guidelines
+
+If you find the code useful, please do put references/stars. To contribute, please follow
+[CONTRIBUTING.md](https://github.com/ZenithClown/.github/blob/master/.github/CONTRIBUTING.md) guidelines.
+
+```{eval-rst}
+.. attention::
+  To contribute, or feature request please raise a PR/Issues at
+  `code-archived/ds-gringotts <https://github.com/code-archived/ds-gringotts>`_
+```
+
+</div>
diff --git a/docs/make.bat 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
+
+%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
diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt
@@ -0,0 +1,8 @@
+myst-parser==2.0.0
+numpy==2.0.1
+pandas==2.2.2
+scipy==1.14.0
+Sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
+sqlparse==0.5.1
+statsmodels==0.14.2
