Merge pull request #8 from jelitox/main

Add base Docs facility

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)

docs/api.rst

@@ -0,0 +1,21 @@
+api
+========
+
+``QClient``
+-------------
+
+.. autofunction:: qw.client.QClient
+
+
+``QueueServer``
+----------------
+
+.. autofunction:: qw.protocols.QueueServer
+
+
+``QWorker``
+--------------
+
+.. autofunction:: qw.server.QWorker
+
+

docs/authors.rst

@@ -0,0 +1,13 @@
+=======
+Authors
+=======
+
+Development Lead
+-----------------
+
+* Jesus Lara <jlara@trocglobal.com>
+
+Contributors
+-------------
+
+* Javier Leon <jleon@trocglobal.com>

docs/changelog.rst

@@ -0,0 +1,6 @@
+
+Changelog
+===========
+
+.. include:: ../CODE_OF_CONDUCT.md
+   :parser: myst_parser.sphinx_

docs/code-of-conduct.rst

@@ -0,0 +1,6 @@
+
+code-of-conduct
+================
+
+.. include:: ../CODE_OF_CONDUCT.md
+   :parser: myst_parser.sphinx_

docs/conf.py

@@ -0,0 +1,49 @@
+# 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
+
+project = 'qworker'
+copyright = '2022, Jesus Lara G.'
+author = 'Jesus Lara G.'
+release = 'Dual License BSD and Apache 2.0'
+
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "myst_parser",
+]
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for autodoc ----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
+
+# Automatically extract typehints when specified and place them in
+# descriptions of the relevant function/method.
+autodoc_typehints = "description"
+
+# Don't show class signature with the class' name.
+autodoc_class_signature = "separated"
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_theme = 'sphinx_rtd_theme'
+#html_theme = 'alabaster'
+html_static_path = ['_static']

docs/config.rst

@@ -0,0 +1,21 @@
+Config
+========
+
+``QClient``
+-------------
+
+.. autofunction:: qw.client.QClient
+
+
+``QueueServer``
+----------------
+
+.. autofunction:: qw.protocols.QueueServer
+
+
+``QWorker``
+--------------
+
+.. autofunction:: qw.server.QWorker
+
+

docs/index.rst

@@ -0,0 +1,53 @@
+.. qworker documentation master file, created by
+   sphinx-quickstart on Fri Sep 16 07:35:11 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to qworker's documentation!
+============================================
+
+
+.. image:: https://img.shields.io/pypi/v/qworker
+   :target: https://pypi.org/project/qworker/
+   :alt: PyPI
+.. image:: https://github.com/phenobarbital/qworker/workflows/CI/badge.svg
+   :target: https://github.com/phenobarbital/qworker/actions?query=workflow%3ACI
+   :alt: GitHub Actions - CI
+.. image:: https://github.com/phenobarbital/qworker/workflows/pre-commit/badge.svg
+   :target: https://github.com/phenobarbital/qworker/actions?query=workflow%3Apre-commit
+   :alt: GitHub Actions - pre-commit
+.. image:: https://img.shields.io/codecov/c/gh/phenobarbital/qworker
+   :target: https://app.codecov.io/gh/phenobarbital/qworker
+   :alt: Codecov
+
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+
+License
+-------
+
+This project is licensed under the terms of the BSD v3. and Apache 2 Dual license.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api
+   config
+   security
+   changelog
+   code-of-conduct
+   authors
+
+
+
+Indices and tables
+==================
+
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`    
+

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

docs/requirements.txt

@@ -0,0 +1,6 @@
+sphinx 
+sphinx-autobuild
+sphinx-rtd-theme 
+myst-parser
+navconfig
+

docs/security.rst

@@ -0,0 +1,6 @@
+
+Security
+=========
+
+.. include:: ../SECURITY.md
+   :parser: myst_parser.sphinx_