diff --git a/__make.d__/release.mk b/__make.d__/release.mk new file mode 100644 index 0000000..bcd1898 --- /dev/null +++ b/__make.d__/release.mk @@ -0,0 +1,18 @@ +# pylibs examples Makefile: Version 1.0 (2025-08-15) + +.ONESHELL: +SHELL = /usr/bin/bash +MAKEFLAGS += --no-print-directory +.SILENT: + +localhelp: +localhelp: + echo -e "Possible options are:" + echo -e "\033[1;33m - release - Run all release rules (unittest, requirements, docs - if available)\e[0m" + + +release: + [[ -d unittest ]] && $(MAKE) -C unittest release + [[ -d requirements ]] && $(MAKE) -C requirements release + [[ -d docs ]] && $(MAKE) -C docs release + diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 82f5662..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,179 +0,0 @@ -# -*- 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 = 'mqtt' -copyright = '2025, Dirk Alders' -author = 'Dirk Alders' - -# 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 ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index d367f78..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. socket_protocol 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:: caching - :members: - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 5451033..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -sphinx -python-docs-theme -paho-mqtt - diff --git a/pylibs/fstools b/pylibs/fstools index 9237f6f..ef8d79b 160000 --- a/pylibs/fstools +++ b/pylibs/fstools @@ -1 +1 @@ -Subproject commit 9237f6f7f77eed79b8163077c1b4d87189193fbe +Subproject commit ef8d79b1871839b662aa823c30ce912580995265 diff --git a/pylibs/mqtt b/pylibs/mqtt index 14e56cc..95dda53 160000 --- a/pylibs/mqtt +++ b/pylibs/mqtt @@ -1 +1 @@ -Subproject commit 14e56ccdbf6594f699b4afcfb4acafe9b899e914 +Subproject commit 95dda53a55b40591bbd5200ae5ea8c354610b913 diff --git a/pylibs/pydocs b/pylibs/pydocs index e61dbc1..6342646 160000 --- a/pylibs/pydocs +++ b/pylibs/pydocs @@ -1 +1 @@ -Subproject commit e61dbc130c4d29f1641869ce3ade9705e455521b +Subproject commit 63426469d7e8ceffb7c14765061a546268c93a94 diff --git a/pylibs/rspec b/pylibs/rspec index 779a6d0..871ea52 160000 --- a/pylibs/rspec +++ b/pylibs/rspec @@ -1 +1 @@ -Subproject commit 779a6d0a1c4e8b5bbdd4a54c4c509212cf2334a3 +Subproject commit 871ea528c0bc9e686a5c0fa4936a2ed715a5b54e diff --git a/pylibs/unittest b/pylibs/unittest index d6d3031..40fa187 160000 --- a/pylibs/unittest +++ b/pylibs/unittest @@ -1 +1 @@ -Subproject commit d6d3031b5119b7bffad9c89587401b3489ba8fd8 +Subproject commit 40fa1872379342bfa8e2db5943d32631aa05ced9