add parser-specific docs & rewrite sudo parser for journald
[logparse.git] / doc / source / conf.py
index 3d190cc0ea1482897d27fb196c46e4f4fbd9de1c..9758585d1c06309e0741a33161ee5e07d434f2af 100644 (file)
 # 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('.'))
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../../"))
+import logparse
 
 
 # -- General configuration ------------------------------------------------
@@ -32,6 +33,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
+    'sphinxarg.ext',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
@@ -39,8 +41,10 @@ extensions = ['sphinx.ext.autodoc',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode']
 
+programoutput_use_ansi = True
+
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['templates/basic']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -53,8 +57,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'logparse'
-copyright = '2019, Andrew Lorimer'
-author = 'Andrew Lorimer'
+author = "Andrew Lorimer https://lorimer.id.au"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -89,7 +92,7 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'haiku'
 
 # 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
@@ -100,7 +103,9 @@ html_theme = 'alabaster'
 # 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']
+#html_static_path = ['static']
+#html_style = 'basic.css'
+
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -109,8 +114,6 @@ html_static_path = ['.static']
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
     '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
     ]
 }
 
@@ -155,8 +158,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'logparse', 'logparse Documentation',
-     [author], 1)
+    (master_doc, 'logparse', 'simple log analyser for servers',
+     [author], 8)
 ]