From ce86a493a9ce1e1da7a6df936a7a91ee22bee7f5 Mon Sep 17 00:00:00 2001 From: Mark van Renswoude Date: Sat, 11 Feb 2017 14:32:07 +0100 Subject: [PATCH] Added the start of the ReadTheDocs documentation --- .gitignore | 2 + docs/Makefile | 20 ++++ docs/Tapeti.Docs.sublime-project | 10 ++ docs/conf.py | 158 +++++++++++++++++++++++++++++++ docs/gettingstarted.rst | 25 +++++ docs/index.rst | 9 ++ docs/introduction.rst | 30 ++++++ docs/make.bat | 36 +++++++ 8 files changed, 290 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/Tapeti.Docs.sublime-project create mode 100644 docs/conf.py create mode 100644 docs/gettingstarted.rst create mode 100644 docs/index.rst create mode 100644 docs/introduction.rst create mode 100644 docs/make.bat diff --git a/.gitignore b/.gitignore index ddbeb74..ecbc623 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ packages/ *.user .nuget.apikey publish/ +*.sublime-workspace +docs/_build/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..4e12993 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Tapeti +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) \ No newline at end of file diff --git a/docs/Tapeti.Docs.sublime-project b/docs/Tapeti.Docs.sublime-project new file mode 100644 index 0000000..80af61d --- /dev/null +++ b/docs/Tapeti.Docs.sublime-project @@ -0,0 +1,10 @@ +{ + "folders": + [ + { + "path": ".", + "file_exclude_patterns": ["*.sublime-project"], + "folder_exclude_patterns": ["_build"] + } + ] +} diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3c38711 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,158 @@ +# -*- coding: utf-8 -*- +# +# Tapeti documentation build configuration file, created by +# sphinx-quickstart on Sat Feb 11 13:02:50 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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('.')) + + +# -- 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 = [] + +# 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' + +# General information about the project. +project = u'Tapeti' +author = u'Mark van Renswoude' +html_show_copyright = False + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'' +# The full version, including alpha/beta/rc tags. +release = u'' + +# 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 patterns also effect to 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 = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +import sphinx_rtd_theme +html_theme = 'sphinx_rtd_theme' +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# 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'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Tapetidoc' + + +# -- 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, 'Tapeti.tex', u'Tapeti Documentation', + u'Mark van Renswoude', '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, 'tapeti', u'Tapeti 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, 'Tapeti', u'Tapeti Documentation', + author, 'Tapeti', 'RabbitMQ library for .NET using controller-based registration.', + 'Miscellaneous'), +] + + + diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst new file mode 100644 index 0000000..34f736d --- /dev/null +++ b/docs/gettingstarted.rst @@ -0,0 +1,25 @@ +Getting started +=============== + +Install packages +---------------- +I'll assume you are familiar with installing NuGet.org packages into your project. + +Find and install the *Tapeti* package. This will also install *Tapeti.Annotations*, which contains the various attributes. + +You will need an integration package as well for your IoC (Inversion of Control) container of choice. At the time of writing, one is provided for `SimpleInjector `_. Simply install *Tapeti.SimpleInjector* as well. + +.. note:: If you need support for your favourite library, implement *IDependencyContainer* using the *Tapeti.SimpleInjector* source as a reference and replace *SimpleInjectorDependencyResolver* with your class name in the example code below. + +Configuring Tapeti +------------------ +.. error:: You've stumbled upon a piece of unfinished documentation. + Behind you is all prior knowledge. In front of you is nothing but emptyness. What do you do? + + 1. Attempt to explore further + 2. Complain to the author and demand your money back + 3. Abandon all hope + + > | + +.. caution:: Tapeti attempts to register it's default implementations in the IoC container during configuration, as well as when starting the connection (to register IPublisher). If your container is immutable after the initial configuration, like SimpleInjector is, make sure that you run the Tapeti configuration before requesting any instances from the container. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..47d4e9f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,9 @@ +Tapeti documentation +==================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + introduction + gettingstarted \ No newline at end of file diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 0000000..049604b --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,30 @@ +Introduction +============ + + | 'Small to medium-sized and classified as "Least Concern" by the IUCN.' + | `Wikipedia `_ + +Tapeti is a wrapper for the RabbitMQ .NET Client designed for long-running microservices. It's main goal is to minimize the amount of messaging code required, and instead focus on the higher-level flow. + +Key features +------------ + +* Consumers are declared using MVC-style controllers and are registered automatically based on annotations +* Publishing requires only the message class, no transport details such as exchange and routing key +* No inheritance required +* Graceful recovery in case of connection issues, and in contrast to most libraries not designed for services, during startup as well +* Extensible using middleware, see for example the Tapeti Flow package + + +What it is not +-------------- +Tapeti is not a general purpose RabbitMQ client. Although some behaviour can be overridden by implementing various interfaces, it enforces it's style of messaging and assumes everyone on the bus speaks the same language. + + +What is missing +--------------- +Durable queues are not created and bound automatically yet. The assumption is made that these queues are initialized during a deploy to ensure messages are persisted even when the consuming service isn't running yet. + +The author shamelessly plugs `RabbitMetaQueue `_, which will probably be integrated into Tapeti at one point. + +Furthermore there are no unit tests yet. This will require a bit more decoupling in the lower levels of the Tapeti code. diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..ac34ccd --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=Tapeti + +if "%1" == "" goto help + +%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.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd