diff options
author | Steven Hiscocks <steven@hiscocks.me.uk> | 2014-03-29 22:07:33 +0000 |
---|---|---|
committer | Steven Hiscocks <steven@hiscocks.me.uk> | 2014-03-29 22:07:33 +0000 |
commit | baeff6141ef8ab14f040999a503a3a7ce5cb6a1c (patch) | |
tree | cfec1b11d5d6d23fb7660ce6e9617eb125b9d503 /doc | |
parent | 70463882913393d1a0ac1ef3c58f8e0960528b2e (diff) | |
download | fail2ban-baeff6141ef8ab14f040999a503a3a7ce5cb6a1c.tar.gz |
DOC: sphinx documentation
Diffstat (limited to 'doc')
47 files changed, 774 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..e2276ba9 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build2 +PAPER = +BUILDDIR = ""build + +# User-friendly check for sphinx-build2 +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Fail2Ban.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Fail2Ban.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Fail2Ban" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Fail2Ban" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 00000000..20845a5a --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- + +import sys +import os + +sys.path.insert(0, ".") +sys.path.insert(0, "..") + +# 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. +#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 = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'numpydoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Fail2Ban' +copyright = u'2014' + +# 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. +# + +from fail2ban.version import version as fail2ban_version +from distutils.version import LooseVersion + +fail2ban_loose_version = LooseVersion(fail2ban_version) + +# The short X.Y version. +version = ".".join(str(_) for _ in fail2ban_loose_version.version[:2]) +# The full version, including alpha/beta/rc tags. +release = fail2ban_version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- 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 = 'default' + +# 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 themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Fail2Bandoc' + + +# -- 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': '', +} + +# 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 = [ + ('index', 'Fail2Ban.tex', u'Fail2Ban Developers\' Documentation', + u'', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'fail2ban', u'Fail2Ban Developers\' Documentation', + [u''], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- 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 = [ + ('index', 'Fail2Ban', u'Fail2Ban Developers\' Documentation', + u'', 'Fail2Ban', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False +autodoc_default_flags = ['members', 'inherited-members', 'undoc-members', 'show-inheritance'] diff --git a/doc/develop.rst b/doc/develop.rst new file mode 100644 index 00000000..2f1c9842 --- /dev/null +++ b/doc/develop.rst @@ -0,0 +1 @@ +.. include:: ../DEVELOP diff --git a/doc/fail2ban.client.actionreader.rst b/doc/fail2ban.client.actionreader.rst new file mode 100644 index 00000000..23e578e2 --- /dev/null +++ b/doc/fail2ban.client.actionreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.actionreader module +=================================== + +.. automodule:: fail2ban.client.actionreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.beautifier.rst b/doc/fail2ban.client.beautifier.rst new file mode 100644 index 00000000..1f35a50b --- /dev/null +++ b/doc/fail2ban.client.beautifier.rst @@ -0,0 +1,7 @@ +fail2ban.client.beautifier module +================================= + +.. automodule:: fail2ban.client.beautifier + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.configparserinc.rst b/doc/fail2ban.client.configparserinc.rst new file mode 100644 index 00000000..01c4c2d0 --- /dev/null +++ b/doc/fail2ban.client.configparserinc.rst @@ -0,0 +1,7 @@ +fail2ban.client.configparserinc module +====================================== + +.. automodule:: fail2ban.client.configparserinc + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.configreader.rst b/doc/fail2ban.client.configreader.rst new file mode 100644 index 00000000..d24db2ca --- /dev/null +++ b/doc/fail2ban.client.configreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.configreader module +=================================== + +.. automodule:: fail2ban.client.configreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.configurator.rst b/doc/fail2ban.client.configurator.rst new file mode 100644 index 00000000..63372f5d --- /dev/null +++ b/doc/fail2ban.client.configurator.rst @@ -0,0 +1,7 @@ +fail2ban.client.configurator module +=================================== + +.. automodule:: fail2ban.client.configurator + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.csocket.rst b/doc/fail2ban.client.csocket.rst new file mode 100644 index 00000000..19e6219a --- /dev/null +++ b/doc/fail2ban.client.csocket.rst @@ -0,0 +1,7 @@ +fail2ban.client.csocket module +============================== + +.. automodule:: fail2ban.client.csocket + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.fail2banreader.rst b/doc/fail2ban.client.fail2banreader.rst new file mode 100644 index 00000000..4fc66532 --- /dev/null +++ b/doc/fail2ban.client.fail2banreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.fail2banreader module +===================================== + +.. automodule:: fail2ban.client.fail2banreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.filterreader.rst b/doc/fail2ban.client.filterreader.rst new file mode 100644 index 00000000..d0e9cf5c --- /dev/null +++ b/doc/fail2ban.client.filterreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.filterreader module +=================================== + +.. automodule:: fail2ban.client.filterreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.jailreader.rst b/doc/fail2ban.client.jailreader.rst new file mode 100644 index 00000000..f57e3b6a --- /dev/null +++ b/doc/fail2ban.client.jailreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.jailreader module +================================= + +.. automodule:: fail2ban.client.jailreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.jailsreader.rst b/doc/fail2ban.client.jailsreader.rst new file mode 100644 index 00000000..d1281248 --- /dev/null +++ b/doc/fail2ban.client.jailsreader.rst @@ -0,0 +1,7 @@ +fail2ban.client.jailsreader module +================================== + +.. automodule:: fail2ban.client.jailsreader + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.client.rst b/doc/fail2ban.client.rst new file mode 100644 index 00000000..9943912d --- /dev/null +++ b/doc/fail2ban.client.rst @@ -0,0 +1,15 @@ +fail2ban.client package +======================= + +.. toctree:: + + fail2ban.client.actionreader + fail2ban.client.beautifier + fail2ban.client.configparserinc + fail2ban.client.configreader + fail2ban.client.configurator + fail2ban.client.csocket + fail2ban.client.fail2banreader + fail2ban.client.filterreader + fail2ban.client.jailreader + fail2ban.client.jailsreader diff --git a/doc/fail2ban.exceptions.rst b/doc/fail2ban.exceptions.rst new file mode 100644 index 00000000..3adc5ea6 --- /dev/null +++ b/doc/fail2ban.exceptions.rst @@ -0,0 +1,7 @@ +fail2ban.exceptions module +========================== + +.. automodule:: fail2ban.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.helpers.rst b/doc/fail2ban.helpers.rst new file mode 100644 index 00000000..28b072cb --- /dev/null +++ b/doc/fail2ban.helpers.rst @@ -0,0 +1,7 @@ +fail2ban.helpers module +======================= + +.. automodule:: fail2ban.helpers + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.protocol.rst b/doc/fail2ban.protocol.rst new file mode 100644 index 00000000..289ccb22 --- /dev/null +++ b/doc/fail2ban.protocol.rst @@ -0,0 +1,7 @@ +fail2ban.protocol module +======================== + +.. automodule:: fail2ban.protocol + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.rst b/doc/fail2ban.rst new file mode 100644 index 00000000..c9b4fbb2 --- /dev/null +++ b/doc/fail2ban.rst @@ -0,0 +1,12 @@ +fail2ban package +================ + +.. toctree:: + + fail2ban.client + fail2ban.server + + fail2ban.exceptions + fail2ban.helpers + fail2ban.protocol + fail2ban.version diff --git a/doc/fail2ban.server.action.rst b/doc/fail2ban.server.action.rst new file mode 100644 index 00000000..c2f9c410 --- /dev/null +++ b/doc/fail2ban.server.action.rst @@ -0,0 +1,7 @@ +fail2ban.server.action module +============================= + +.. automodule:: fail2ban.server.action + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.actions.rst b/doc/fail2ban.server.actions.rst new file mode 100644 index 00000000..8c701c72 --- /dev/null +++ b/doc/fail2ban.server.actions.rst @@ -0,0 +1,7 @@ +fail2ban.server.actions module +============================== + +.. automodule:: fail2ban.server.actions + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.asyncserver.rst b/doc/fail2ban.server.asyncserver.rst new file mode 100644 index 00000000..5ddfa50f --- /dev/null +++ b/doc/fail2ban.server.asyncserver.rst @@ -0,0 +1,7 @@ +fail2ban.server.asyncserver module +================================== + +.. automodule:: fail2ban.server.asyncserver + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.banmanager.rst b/doc/fail2ban.server.banmanager.rst new file mode 100644 index 00000000..96b1a4e9 --- /dev/null +++ b/doc/fail2ban.server.banmanager.rst @@ -0,0 +1,7 @@ +fail2ban.server.banmanager module +================================= + +.. automodule:: fail2ban.server.banmanager + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.database.rst b/doc/fail2ban.server.database.rst new file mode 100644 index 00000000..40002258 --- /dev/null +++ b/doc/fail2ban.server.database.rst @@ -0,0 +1,7 @@ +fail2ban.server.database module +=============================== + +.. automodule:: fail2ban.server.database + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.datedetector.rst b/doc/fail2ban.server.datedetector.rst new file mode 100644 index 00000000..9a367734 --- /dev/null +++ b/doc/fail2ban.server.datedetector.rst @@ -0,0 +1,7 @@ +fail2ban.server.datedetector module +=================================== + +.. automodule:: fail2ban.server.datedetector + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.datetemplate.rst b/doc/fail2ban.server.datetemplate.rst new file mode 100644 index 00000000..4959e805 --- /dev/null +++ b/doc/fail2ban.server.datetemplate.rst @@ -0,0 +1,7 @@ +fail2ban.server.datetemplate module +=================================== + +.. automodule:: fail2ban.server.datetemplate + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.faildata.rst b/doc/fail2ban.server.faildata.rst new file mode 100644 index 00000000..c11d8208 --- /dev/null +++ b/doc/fail2ban.server.faildata.rst @@ -0,0 +1,7 @@ +fail2ban.server.faildata module +=============================== + +.. automodule:: fail2ban.server.faildata + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.failmanager.rst b/doc/fail2ban.server.failmanager.rst new file mode 100644 index 00000000..6e4e8704 --- /dev/null +++ b/doc/fail2ban.server.failmanager.rst @@ -0,0 +1,7 @@ +fail2ban.server.failmanager module +================================== + +.. automodule:: fail2ban.server.failmanager + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.failregex.rst b/doc/fail2ban.server.failregex.rst new file mode 100644 index 00000000..f473c51f --- /dev/null +++ b/doc/fail2ban.server.failregex.rst @@ -0,0 +1,7 @@ +fail2ban.server.failregex module +================================ + +.. automodule:: fail2ban.server.failregex + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.filter.rst b/doc/fail2ban.server.filter.rst new file mode 100644 index 00000000..41279013 --- /dev/null +++ b/doc/fail2ban.server.filter.rst @@ -0,0 +1,7 @@ +fail2ban.server.filter module +============================= + +.. automodule:: fail2ban.server.filter + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.filtergamin.rst b/doc/fail2ban.server.filtergamin.rst new file mode 100644 index 00000000..f248772f --- /dev/null +++ b/doc/fail2ban.server.filtergamin.rst @@ -0,0 +1,7 @@ +fail2ban.server.filtergamin module +================================== + +.. automodule:: fail2ban.server.filtergamin + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.filterpoll.rst b/doc/fail2ban.server.filterpoll.rst new file mode 100644 index 00000000..d87e461f --- /dev/null +++ b/doc/fail2ban.server.filterpoll.rst @@ -0,0 +1,7 @@ +fail2ban.server.filterpoll module +================================= + +.. automodule:: fail2ban.server.filterpoll + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.filterpyinotify.rst b/doc/fail2ban.server.filterpyinotify.rst new file mode 100644 index 00000000..0ea312bf --- /dev/null +++ b/doc/fail2ban.server.filterpyinotify.rst @@ -0,0 +1,7 @@ +fail2ban.server.filterpyinotify module +====================================== + +.. automodule:: fail2ban.server.filterpyinotify + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.filtersystemd.rst b/doc/fail2ban.server.filtersystemd.rst new file mode 100644 index 00000000..1b71a2c8 --- /dev/null +++ b/doc/fail2ban.server.filtersystemd.rst @@ -0,0 +1,7 @@ +fail2ban.server.filtersystemd module +==================================== + +.. automodule:: fail2ban.server.filtersystemd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.jail.rst b/doc/fail2ban.server.jail.rst new file mode 100644 index 00000000..b41077bf --- /dev/null +++ b/doc/fail2ban.server.jail.rst @@ -0,0 +1,7 @@ +fail2ban.server.jail module +=========================== + +.. automodule:: fail2ban.server.jail + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.jails.rst b/doc/fail2ban.server.jails.rst new file mode 100644 index 00000000..7e9390f7 --- /dev/null +++ b/doc/fail2ban.server.jails.rst @@ -0,0 +1,7 @@ +fail2ban.server.jails module +============================ + +.. automodule:: fail2ban.server.jails + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.jailthread.rst b/doc/fail2ban.server.jailthread.rst new file mode 100644 index 00000000..db11f7a9 --- /dev/null +++ b/doc/fail2ban.server.jailthread.rst @@ -0,0 +1,7 @@ +fail2ban.server.jailthread module +================================= + +.. automodule:: fail2ban.server.jailthread + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.mytime.rst b/doc/fail2ban.server.mytime.rst new file mode 100644 index 00000000..1313d20b --- /dev/null +++ b/doc/fail2ban.server.mytime.rst @@ -0,0 +1,7 @@ +fail2ban.server.mytime module +============================= + +.. automodule:: fail2ban.server.mytime + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.rst b/doc/fail2ban.server.rst new file mode 100644 index 00000000..fdc3bd20 --- /dev/null +++ b/doc/fail2ban.server.rst @@ -0,0 +1,28 @@ +fail2ban.server package +======================= + +.. toctree:: + + fail2ban.server.action + fail2ban.server.actions + fail2ban.server.asyncserver + fail2ban.server.banmanager + fail2ban.server.database + fail2ban.server.datedetector + fail2ban.server.datetemplate + fail2ban.server.faildata + fail2ban.server.failmanager + fail2ban.server.failregex + fail2ban.server.filter + fail2ban.server.filtergamin + fail2ban.server.filterpoll + fail2ban.server.filterpyinotify + fail2ban.server.filtersystemd + fail2ban.server.jail + fail2ban.server.jails + fail2ban.server.jailthread + fail2ban.server.mytime + fail2ban.server.server + fail2ban.server.strptime + fail2ban.server.ticket + fail2ban.server.transmitter diff --git a/doc/fail2ban.server.server.rst b/doc/fail2ban.server.server.rst new file mode 100644 index 00000000..be14b35c --- /dev/null +++ b/doc/fail2ban.server.server.rst @@ -0,0 +1,7 @@ +fail2ban.server.server module +============================= + +.. automodule:: fail2ban.server.server + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.strptime.rst b/doc/fail2ban.server.strptime.rst new file mode 100644 index 00000000..81ff181c --- /dev/null +++ b/doc/fail2ban.server.strptime.rst @@ -0,0 +1,7 @@ +fail2ban.server.strptime module +=============================== + +.. automodule:: fail2ban.server.strptime + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.ticket.rst b/doc/fail2ban.server.ticket.rst new file mode 100644 index 00000000..27a1b53b --- /dev/null +++ b/doc/fail2ban.server.ticket.rst @@ -0,0 +1,7 @@ +fail2ban.server.ticket module +============================= + +.. automodule:: fail2ban.server.ticket + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.server.transmitter.rst b/doc/fail2ban.server.transmitter.rst new file mode 100644 index 00000000..cb62fa97 --- /dev/null +++ b/doc/fail2ban.server.transmitter.rst @@ -0,0 +1,7 @@ +fail2ban.server.transmitter module +================================== + +.. automodule:: fail2ban.server.transmitter + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/fail2ban.version.rst b/doc/fail2ban.version.rst new file mode 100644 index 00000000..cc97380a --- /dev/null +++ b/doc/fail2ban.version.rst @@ -0,0 +1,7 @@ +fail2ban.version module +======================= + +.. automodule:: fail2ban.version + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/filters.rst b/doc/filters.rst new file mode 100644 index 00000000..4d19acf8 --- /dev/null +++ b/doc/filters.rst @@ -0,0 +1 @@ +.. include:: ../FILTERS diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 00000000..9f6c94ac --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,19 @@ +Welcome to Fail2Ban's developers documentation! +=============================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + develop + filters + release + fail2ban + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + diff --git a/doc/release.rst b/doc/release.rst new file mode 100644 index 00000000..bdd0430a --- /dev/null +++ b/doc/release.rst @@ -0,0 +1 @@ +.. include:: ../RELEASE diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..a2954e31 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1 @@ +numpydoc |