diff --git a/.gitignore b/.gitignore index c7ca2f3..463b979 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +_build +*.rst + # ---> Python # Byte-compiled / optimized / DLL files __pycache__/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..4d0363e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,12 @@ +[submodule "state_machine"] + path = state_machine + url = https://git.mount-mockery.de/pylib/state_machine +[submodule "socket_protocol"] + path = socket_protocol + url = https://git.mount-mockery.de/pylib/socket_protocol +[submodule "stringtools"] + path = stringtools + url = https://git.mount-mockery.de/pylib/stringtools +[submodule "report"] + path = report + url = https://git.mount-mockery.de/pylib/report diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2a0c654 --- /dev/null +++ b/Makefile @@ -0,0 +1,47 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build +MODULES = $(sort \ + state_machine\ + stringtools\ + stringtools.csp\ + stringtools.stp\ +) + +# Put it first so that "make" without argument is like "make help". + +.PHONY: all help Makefile + +all: clean index.rst $(MODULES) html + +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +html: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: Makefile + rm -f *.rst + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +index.rst: Makefile + @echo Generating $@ + @echo "Indices and tables\n==================\n\n* :ref:\`genindex\`\n* :ref:\`modindex\`\n* :ref:\`search\`\n" > $@ + @echo "Modules\n=======\n\n.. toctree::\n :maxdepth: 2\n" >> $@ + +%: Makefile + @echo "Preparing $@" + @echo ".. automodule:: $@\n :members:" > $@.rst + @if [ "$(findstring .,$@)" != "." ]; then \ + git -C $@ checkout master; \ + git -C $@ pull; \ + make -C $@/_examples_ clean all; \ + fi + @echo " $@.rst" >> index.rst; \ diff --git a/_static/.gitkeep b/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..8c08c7b --- /dev/null +++ b/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 = 'Pylibs Documentation' +copyright = '2021, 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', + 'sphinx_rtd_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 = None + +# 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 = 'sphinx_rtd_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 = 'socket_protocoldoc' + + +# -- 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, 'socket_protocol.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, 'socket_protocol', 'socket_protocol 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, 'socket_protocol', 'socket_protocol Documentation', + author, 'socket_protocol', '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/report b/report new file mode 160000 index 0000000..25889f2 --- /dev/null +++ b/report @@ -0,0 +1 @@ +Subproject commit 25889f225b3593d515e37bebffef21458c961f64 diff --git a/socket_protocol b/socket_protocol new file mode 160000 index 0000000..eff44b7 --- /dev/null +++ b/socket_protocol @@ -0,0 +1 @@ +Subproject commit eff44b7988cbdaf87865010b5b8919dc0d6f31db diff --git a/state_machine b/state_machine new file mode 160000 index 0000000..2bd8162 --- /dev/null +++ b/state_machine @@ -0,0 +1 @@ +Subproject commit 2bd816297527e77fb44a03ddf4aca35124f6f303 diff --git a/stringtools b/stringtools new file mode 160000 index 0000000..f545386 --- /dev/null +++ b/stringtools @@ -0,0 +1 @@ +Subproject commit f5453861f646873b1800e657faa9e4b8684c21ba