summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Sommerseth <davids@redhat.com>2015-10-23 19:13:02 +0200
committerDavid Sommerseth <davids@redhat.com>2015-10-23 19:13:39 +0200
commit346df56272a67112cbdc14fc91bc17022f8777c7 (patch)
treee276b4e5c8fb4fba1b0ff557704d0f1f58dc8f54
parent860cf9a026a4c591057783e9bc6929b24dba96f3 (diff)
downloadlogactio-346df56272a67112cbdc14fc91bc17022f8777c7.tar.gz
logactio-346df56272a67112cbdc14fc91bc17022f8777c7.tar.xz
logactio-346df56272a67112cbdc14fc91bc17022f8777c7.zip
Prepare for a v1.0 release
Ensure we also have man pages properly generated too. Signed-off-by: David Sommerseth <davids@redhat.com>
-rw-r--r--docs/source/conf.py15
-rw-r--r--docs/source/man.rst26
-rw-r--r--setup.py4
3 files changed, 36 insertions, 9 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 1f3e300..deae582 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -25,7 +25,8 @@ import sys, os
# 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.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -41,16 +42,16 @@ master_doc = 'index'
# General information about the project.
project = u'logactio'
-copyright = u'2012, David Sommerseth'
+copyright = u'2012-2015, David Sommerseth'
# 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 = '0.01'
+version = '1.0'
# The full version, including alpha/beta/rc tags.
-release = '0.01'
+release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -211,8 +212,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'logactio', u'logactio Documentation',
- [u'David Sommerseth'], 1)
+ ('man', 'logactio', u'logactio Documentation',
+ [u'David Sommerseth'], 7)
]
@@ -222,7 +223,7 @@ man_pages = [
epub_title = u'logactio'
epub_author = u'David Sommerseth'
epub_publisher = u'David Sommerseth'
-epub_copyright = u'2012, David Sommerseth'
+epub_copyright = u'2012-2015, David Sommerseth'
# The language of the text. It defaults to the language option
# or en if the language is not set.
diff --git a/docs/source/man.rst b/docs/source/man.rst
new file mode 100644
index 0000000..14ed0b9
--- /dev/null
+++ b/docs/source/man.rst
@@ -0,0 +1,26 @@
+.. logactio documentation master file, created by
+ sphinx-quickstart on Mon Sep 17 10:59:56 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Logactio - simple log file watcher framework
+============================================
+
+Logactio is a simple framework for watching log files and do certain actions
+when some predefined events happens. It's modular by design and can make use
+of external reporter modules to handle the actions.
+
+The use case for logactio is on a running server where you want to alert
+users and/or sys-admins when something unexpected happens.
+
+Simple reporter modules using HTTP/HTTPS, SMTP or AMQP/Qpid are bundled with
+logactio.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ configuration
+ starting
+
diff --git a/setup.py b/setup.py
index e8cb2ed..a4e9706 100644
--- a/setup.py
+++ b/setup.py
@@ -8,13 +8,13 @@ import commands, sys
# Get PYTHONLIB with no prefix so --prefix installs work.
PYTHONLIB = join(get_python_lib(standard_lib=1, prefix=''), 'site-packages')
-version = "0.01"
+version = "1.0"
setup(name="logactio",
version=version,
description="Simple framework for executing actions on certain log events",
author="David Sommerseth",
- author_email="dazo@users.sourceforge.net",
+ author_email="dazo@eurephia.org",
url="http://fedorapeople.org/cgit/dsommers/public_git/logactio.git/",
license="GPLv2 only",
packages=["LogActio", "LogActio.Reporters"],