Initial pydocs module

replace.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+
+# A script to replace text_a with text_b in a file and report the changes.
+#
+# Usage: ./replace_and_report.sh <filename> "text_a" "text_b"
+
+# Check if the correct number of arguments are provided
+if [ "$#" -ne 3 ]; then
+  echo "Error: Incorrect number of arguments."
+  echo "Usage: $0 <filename> \"text_a\" \"text_b\""
+  exit 1
+fi
+
+FILE="$1"
+TEXT_A="$2"
+TEXT_B="$3"
+
+# Check if the file exists
+if [ ! -f "$FILE" ]; then
+  echo "Error: File '$FILE' not found."
+  exit 1
+fi
+
+echo "Searching for '$TEXT_A' in '$FILE' and replacing it with '$TEXT_B'..."
+echo "---"
+
+# Use `grep` to find the line numbers where TEXT_A exists
+# The output is a list of line numbers
+LINE_NUMBERS=$(grep -n "$TEXT_A" "$FILE" | cut -d: -f1)
+
+# Check if any matches were found
+if [ -z "$LINE_NUMBERS" ]; then
+  echo "No occurrences of '$TEXT_A' found. No replacements made."
+  exit 0
+fi
+
+# Loop through each line number where a replacement will be made
+for line_number in $LINE_NUMBERS; do
+  # Get the original line content before the replacement
+  original_line=$(sed -n "${line_number}p" "$FILE")
+  
+  # Perform the replacement using `sed` on the specific line
+  sed -i "${line_number}s/${TEXT_A}/${TEXT_B}/g" "$FILE"
+  
+  # Get the new line content after the replacement
+  new_line=$(sed -n "${line_number}p" "$FILE")
+  
+  echo "Line $line_number:"
+  echo "  - Original: $original_line"
+  echo "  - New:      $new_line"
+  echo "---"
+done
+
+echo "Replacements complete. Changes saved to '$FILE'."

requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+python-docs-theme
+

sphinx.mk

@@ -0,0 +1,52 @@
+# You can set these variables from the command line.
+.ONESHELL:
+SHELL = /usr/bin/bash
+.SILENT:
+
+SPHINXOPTS    =
+SPHINXBUILD   = venv/bin/sphinx-build
+SPHINXPRJ     = $(shell basename `dirname \`pwd\``)
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+test:
+	echo $(SPHINXPRJ)
+
+localhelp:
+	echo -e "Possible documentation options are:"
+	echo -e "\033[1;33m  - html                      - Create a local documentation files\e[0m"
+	echo -e "\033[1;33m  - view                      - Create a local documentation files and view them\e[0m"
+	echo -e "\033[1;33m  - release                   - Create a local documentation files and movem them to the module\e[0m $(SPHINXPRJ)/_docs_"
+
+conf.py: pydocs/templates/conf.py
+	cp pydocs/templates/conf.py .
+	pydocs/replace.sh conf.py "<module_name>" "$(SPHINXPRJ)"
+	pydocs/replace.sh conf.py "<year>" "$$(date +%Y)"
+	pydocs/replace.sh conf.py "<author>" "Dirk Alders"
+
+index.rst: pydocs/templates/index.rst
+	cp pydocs/templates/index.rst .
+	pydocs/replace.sh index.rst "<module_name>" "$(SPHINXPRJ)"
+
+html: $(SPHINXPRJ) conf.py index.rst
+	echo -e "\e[1m  * Generated html files...\e[0m"
+	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+$(SPHINXPRJ):
+	make --no-print-directory -C $@/_examples_ all
+
+localclean:
+	echo -e "\033[1;33mCleanung up docs...\033[00m"
+	echo -e "\e[1m  * Sphix config files...\e[0m"
+	rm -vf conf.py index.rst
+	echo -e "\e[1m  * Sphix build directory...\e[0m"
+	rm -rf $(BUILDDIR)
+	make --no-print-directory -kC $(SPHINXPRJ)/_examples_ clean
+
+release: html
+	rm -rf $(SPHINXPRJ)/_docs_
+	mv $(BUILDDIR)/html $(SPHINXPRJ)/_docs_
+
+view: html
+	xdg-open $(BUILDDIR)/html/index.html
+

templates/conf.py

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = '<module_name>'
+copyright = '<year>, <author>'
+author = '<author>'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.autodoc',
+    'sphinx.ext.coverage',
+    'python_docs_theme',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# 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']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = 'python_docs_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'cachingdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'caching.tex', 'socket\\_protocol Documentation',
+     'Dirk Alders', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'caching', 'caching Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'caching', 'caching Documentation',
+     author, 'caching', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

templates/index.rst

@@ -0,0 +1,24 @@
+.. documentation master file, created by
+   sphinx-quickstart on Fri Jan  1 19:56:01 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to cachings's documentation!
+====================================
+
+.. automodule:: <module_name>
+   :members:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+