logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ihabu...@apache.org
Subject [09/23] git commit: Initial implementation of the new manual
Date Sat, 14 Dec 2013 14:56:55 GMT
Initial implementation of the new manual

The manual is generated using Sphinx. Source pages are in reStructuredText
markup langauge. The commit includes a custom theme based on Bootstrap
(unfinished). Building required python, see README.rst for instructions.


Project: http://git-wip-us.apache.org/repos/asf/logging-log4php/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4php/commit/4780fc1e
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4php/tree/4780fc1e
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4php/diff/4780fc1e

Branch: refs/heads/develop
Commit: 4780fc1e6474242ec99b8e228bc837b64742d95b
Parents: a5bcd95
Author: Ivan Habunek <ivan.habunek@gmail.com>
Authored: Mon Dec 17 15:52:25 2012 +0100
Committer: Ivan Habunek <ivan.habunek@gmail.com>
Committed: Mon Dec 17 15:52:25 2012 +0100

----------------------------------------------------------------------
 docs/.gitignore                                 |    2 +
 docs/Makefile                                   |  153 +
 docs/README.rst                                 |   44 +
 docs/_ext/log4phpdocs.py                        |   17 +
 docs/_ext/log4phpdocs.pyc                       |  Bin 0 -> 1073 bytes
 docs/_theme/log4php/defindex.html               |   35 +
 docs/_theme/log4php/domainindex.html            |   56 +
 docs/_theme/log4php/genindex-single.html        |   65 +
 docs/_theme/log4php/genindex-split.html         |   41 +
 docs/_theme/log4php/genindex.html               |   77 +
 docs/_theme/log4php/globaltoc.html              |   11 +
 docs/_theme/log4php/layout.html                 |  120 +
 docs/_theme/log4php/localtoc.html               |   13 +
 docs/_theme/log4php/opensearch.xml              |   10 +
 docs/_theme/log4php/page.html                   |   13 +
 docs/_theme/log4php/relations.html              |   19 +
 docs/_theme/log4php/search.html                 |   56 +
 docs/_theme/log4php/searchbox.html              |   24 +
 docs/_theme/log4php/searchresults.html          |   36 +
 docs/_theme/log4php/sourcelink.html             |   16 +
 .../static/bootstrap/css/bootstrap-2.2.1.css    | 5893 +++++++++++
 .../bootstrap/css/bootstrap-2.2.1.min.css       |    9 +
 .../css/bootstrap-responsive-2.2.1.css          | 1088 ++
 .../css/bootstrap-responsive-2.2.1.min.css      |    9 +
 .../img/glyphicons-halflings-white.png          |  Bin 0 -> 8777 bytes
 .../bootstrap/img/glyphicons-halflings.png      |  Bin 0 -> 12799 bytes
 .../static/bootstrap/js/bootstrap-2.2.1.js      | 2025 ++++
 .../static/bootstrap/js/bootstrap-2.2.1.min.js  |    6 +
 docs/_theme/log4php/static/favicon.ico          |  Bin 0 -> 3638 bytes
 docs/_theme/log4php/static/jquery-1.8.2.js      | 9440 ++++++++++++++++++
 docs/_theme/log4php/static/jquery-1.8.2.min.js  |    2 +
 docs/_theme/log4php/static/log4php.css_t        |   63 +
 docs/_theme/log4php/static/log4php.js           |   55 +
 docs/_theme/log4php/theme.conf                  |    4 +
 docs/appenders/console.rst                      |   72 +
 docs/appenders/daily-file.rst                   |  126 +
 docs/appenders/echo.rst                         |   84 +
 docs/appenders/file.rst                         |   91 +
 docs/appenders/firephp.rst                      |   87 +
 docs/appenders/index.rst                        |  126 +
 docs/appenders/mail-event.rst                   |   90 +
 docs/appenders/mail.rst                         |   99 +
 docs/appenders/mongodb.rst                      |   92 +
 docs/conf.py                                    |  303 +
 docs/configuration.rst                          |  278 +
 docs/filters/deny-all.rst                       |   91 +
 docs/filters/index.rst                          |  114 +
 docs/filters/level-match.rst                    |   66 +
 docs/filters/level-range.rst                    |   70 +
 docs/filters/string-match.rst                   |   70 +
 docs/index.rst                                  |   32 +
 docs/introduction.rst                           |   65 +
 docs/layouts/html.rst                           |  123 +
 docs/layouts/index.rst                          |   24 +
 docs/layouts/pattern.rst                        |  498 +
 docs/layouts/serialized.rst                     |   72 +
 docs/layouts/simple.rst                         |   71 +
 docs/layouts/ttcc.rst                           |  115 +
 docs/layouts/xml.rst                            |  137 +
 docs/make.bat                                   |  190 +
 docs/quickstart.rst                             |  180 +
 docs/requirements.txt                           |    1 +
 62 files changed, 22769 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/.gitignore
----------------------------------------------------------------------
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..540cb06
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+_env
+_build
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/Makefile
----------------------------------------------------------------------
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..6ae42f1
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# 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 "  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 "  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/Apachelog4php.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Apachelog4php.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/Apachelog4php"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Apachelog4php"
+	@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."
+
+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."

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/README.rst
----------------------------------------------------------------------
diff --git a/docs/README.rst b/docs/README.rst
new file mode 100644
index 0000000..7cb1e92
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1,44 @@
+============================
+Apache log4php documentation
+============================
+
+This directory contains the documentation for Apache log4php.
+
+The documentation is in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
format and 
+can be viewed using any text editor. Conversion to other formats, such as html, epub and
pdf is 
+achieved by using the `Sphinx documentation system <http://sphinx-doc.org/>`_, and
requires 
+`Python <http://python.org/>`_.
+
+To render the documentation to HTML:
+
+* install Sphinx (using ``sudo pip install Sphinx`` or some other method)
+* using a virtual environment is recommended
+* while in the ``docs`` directory, run ``make html``
+
+The documentation will be rendered to ``_build/html/``.
+
+Theme notes
+===========
+
+Apache log4php uses a custom Sphinx theme called (very imaginatively) `log4php`. The theme
is 
+located under ``_theme/log4php``.
+
+One specific hack which this theme provides is making html tabs which are most frequently
used 
+for displaying XML and PHP variants of the same configuration code.
+
+To generate tabs, do the following:
+
+.. code-block:: rst
+
+    .. container:: tabs
+
+        .. rubric:: XML format
+        .. code-block:: xml
+
+        <div id="xml_code">...</div>
+
+        .. rubric:: PHP format
+        .. code-block:: php
+
+        array("php_code" => array(...))
+

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_ext/log4phpdocs.py
----------------------------------------------------------------------
diff --git a/docs/_ext/log4phpdocs.py b/docs/_ext/log4phpdocs.py
new file mode 100644
index 0000000..04f57e4
--- /dev/null
+++ b/docs/_ext/log4phpdocs.py
@@ -0,0 +1,17 @@
+from sphinx.writers.html import HTMLTranslator
+
+def setup(app):
+    pass
+
+
+class Log4phpHTMLTranslator(HTMLTranslator):
+
+    def visit_table(self, node):
+        """
+        Overrides default table rendering to remove border attribute and set
+        default table classes.
+        TODO: See if default table classes can be moved to config file
+        """
+        classes = 'table table-bordered table-hover'
+        self.body.append(
+            self.starttag(node, 'table', CLASS=classes))

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_ext/log4phpdocs.pyc
----------------------------------------------------------------------
diff --git a/docs/_ext/log4phpdocs.pyc b/docs/_ext/log4phpdocs.pyc
new file mode 100644
index 0000000..fdcabef
Binary files /dev/null and b/docs/_ext/log4phpdocs.pyc differ

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/defindex.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/defindex.html b/docs/_theme/log4php/defindex.html
new file mode 100644
index 0000000..ce8d3af
--- /dev/null
+++ b/docs/_theme/log4php/defindex.html
@@ -0,0 +1,35 @@
+{#
+    basic/defindex.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Default template for the "index" page.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{% set title = _('Overview') %}
+{% block body %}
+  <h1>{{ docstitle|e }}</h1>
+  <p>
+    Welcome! This is
+    {% block description %}the documentation for {{ project|e }}
+    {{ release|e }}{% if last_updated %}, last updated {{ last_updated|e }}{% endif %}{%
endblock %}.
+  </p>
+  {% block tables %}
+  <p><strong>{{ _('Indices and tables:') }}</strong></p>
+  <table class="contentstable" align="center"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">{{
_('Complete Table of Contents') }}</a><br>
+         <span class="linkdescr">{{ _('lists all sections and subsections') }}</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">{{
_('Search Page') }}</a><br>
+         <span class="linkdescr">{{ _('search this documentation') }}</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">{{
_('Global Module Index') }}</a><br>
+         <span class="linkdescr">{{ _('quick access to all modules') }}</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">{{
_('General Index') }}</a><br>
+         <span class="linkdescr">{{ _('all functions, classes, terms') }}</span></p>
+    </td></tr>
+  </table>
+  {% endblock %}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/domainindex.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/domainindex.html b/docs/_theme/log4php/domainindex.html
new file mode 100644
index 0000000..947a01e
--- /dev/null
+++ b/docs/_theme/log4php/domainindex.html
@@ -0,0 +1,56 @@
+{#
+    basic/domainindex.html
+    ~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for domain indices (module index, ...).
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{% set title = indextitle %}
+{% block extrahead %}
+{{ super() }}
+{% if not embedded and collapse_index %}
+    <script type="text/javascript">
+      DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
+    </script>
+{% endif %}
+{% endblock %}
+{% block body %}
+
+   {%- set groupid = idgen() %}
+
+   <h1>{{ indextitle }}</h1>
+
+   <div class="modindex-jumpbox">
+   {%- for (letter, entries) in content %}
+   <a href="#cap-{{ letter }}"><strong>{{ letter }}</strong></a>
+     {%- if not loop.last %} | {% endif %}
+   {%- endfor %}
+   </div>
+
+   <table class="indextable modindextable" cellspacing="0" cellpadding="2">
+   {%- for letter, entries in content %}
+     <tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
+     <tr class="cap" id="cap-{{ letter }}"><td></td><td>
+       <strong>{{ letter }}</strong></td><td></td></tr>
+     {%- for (name, grouptype, page, anchor, extra, qualifier, description)
+             in entries %}
+     <tr{% if grouptype == 2 %} class="cg-{{ groupid.current() }}"{% endif %}>
+       <td>{% if grouptype == 1 -%}
+         <img src="{{ pathto('_static/minus.png', 1) }}" class="toggler"
+              id="toggle-{{ groupid.next() }}" style="display: none" alt="-" />
+           {%- endif %}</td>
+       <td>{% if grouptype == 2 %}&nbsp;&nbsp;&nbsp;{% endif %}
+       {% if page %}<a href="{{ pathto(page) }}#{{ anchor }}">{% endif -%}
+       <tt class="xref">{{ name|e }}</tt>
+       {%- if page %}</a>{% endif %}
+     {%- if extra %} <em>({{ extra|e }})</em>{% endif -%}
+     </td><td>{% if qualifier %}<strong>{{ qualifier|e }}:</strong>{%
endif %}
+       <em>{{ description|e }}</em></td></tr>
+     {%- endfor %}
+   {%- endfor %}
+   </table>
+
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/genindex-single.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/genindex-single.html b/docs/_theme/log4php/genindex-single.html
new file mode 100644
index 0000000..eff8c1c
--- /dev/null
+++ b/docs/_theme/log4php/genindex-single.html
@@ -0,0 +1,65 @@
+{#
+    basic/genindex-single.html
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for a "single" page of a split index.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% macro indexentries(firstname, links) %}
+  <dt>
+  {%- if links -%}
+    <a href="{{ links[0][1] }}">
+    {%- if links[0][0] %}<strong>{% endif -%}
+    {{ firstname|e }}
+    {%- if links[0][0] %}</strong>{% endif -%}
+    </a>
+
+    {%- for ismain, link in links[1:] -%}
+      , <a href="{{ link }}">{% if ismain %}<strong>{% endif -%}
+      [{{ loop.index }}]
+      {%- if ismain %}</strong>{% endif -%}
+      </a>
+    {%- endfor %}
+  {%- else %}
+    {{ firstname|e }}
+  {%- endif %}
+  </dt>
+{% endmacro %}
+
+{% extends "layout.html" %}
+{% set title = _('Index') %}
+{% block body %}
+
+<h1 id="index">{% trans key=key %}Index &ndash; {{ key }}{% endtrans %}</h1>
+
+<table style="width: 100%" class="indextable"><tr>
+  {%- for column in entries|slice(2) if column %}
+  <td style="width: 33%" valign="top"><dl>
+    {%- for entryname, (links, subitems) in column %}
+      {{ indexentries(entryname, links) }}
+      {%- if subitems %}
+      <dd><dl>
+      {%- for subentryname, subentrylinks in subitems %}
+        {{ indexentries(subentryname, subentrylinks) }}
+      {%- endfor %}
+      </dl></dd>
+      {%- endif -%}
+    {%- endfor %}
+  </dl></td>
+  {%- endfor %}
+</tr></table>
+
+{% endblock %}
+
+{% block sidebarrel %}
+   <h4>Index</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on
one page') }}</strong></a></p>
+   {{ super() }}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/genindex-split.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/genindex-split.html b/docs/_theme/log4php/genindex-split.html
new file mode 100644
index 0000000..6da88a1
--- /dev/null
+++ b/docs/_theme/log4php/genindex-split.html
@@ -0,0 +1,41 @@
+{#
+    basic/genindex-split.html
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for a "split" index overview page.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{% set title = _('Index') %}
+{% block body %}
+
+   <h1 id="index">{{ _('Index') }}</h1>
+
+   <p>{{ _('Index pages by letter') }}:</p>
+
+   <div class="genindex-jumpbox">
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on
one page') }}</strong>
+                                               ({{ _('can be huge') }})</a></p>
+   </div>
+
+{% endblock %}
+
+{% block sidebarrel %}
+{% if split_index %}
+   <h4>Index</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on
one page') }}</strong></a></p>
+{% endif %}
+   {{ super() }}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/genindex.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/genindex.html b/docs/_theme/log4php/genindex.html
new file mode 100644
index 0000000..7bc002b
--- /dev/null
+++ b/docs/_theme/log4php/genindex.html
@@ -0,0 +1,77 @@
+{#
+    basic/genindex.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Template for an "all-in-one" index.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% macro indexentries(firstname, links) %}
+  <dt>
+  {%- if links -%}
+    <a href="{{ links[0][1] }}">
+    {%- if links[0][0] %}<strong>{% endif -%}
+    {{ firstname|e }}
+    {%- if links[0][0] %}</strong>{% endif -%}
+    </a>
+
+    {%- for ismain, link in links[1:] -%}
+      , <a href="{{ link }}">{% if ismain %}<strong>{% endif -%}
+      [{{ loop.index }}]
+      {%- if ismain %}</strong>{% endif -%}
+      </a>
+    {%- endfor %}
+  {%- else %}
+    {{ firstname|e }}
+  {%- endif %}
+  </dt>
+{% endmacro %}
+
+{% extends "layout.html" %}
+{% set title = _('Index') %}
+{% block body %}
+
+<h1 id="index">{{ _('Index') }}</h1>
+
+<div class="genindex-jumpbox">
+ {% for key, dummy in genindexentries -%}
+ <a href="#{{ key }}"><strong>{{ key }}</strong></a>
+ {% if not loop.last %}| {% endif %}
+ {%- endfor %}
+</div>
+
+{%- for key, entries in genindexentries %}
+<h2 id="{{ key }}">{{ key }}</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  {%- for column in entries|slice(2) if column %}
+  <td style="width: 33%" valign="top"><dl>
+    {%- for entryname, (links, subitems) in column %}
+      {{ indexentries(entryname, links) }}
+      {%- if subitems %}
+      <dd><dl>
+      {%- for subentryname, subentrylinks in subitems %}
+        {{ indexentries(subentryname, subentrylinks) }}
+      {%- endfor %}
+      </dl></dd>
+      {%- endif -%}
+    {%- endfor %}
+  </dl></td>
+  {%- endfor %}
+</tr></table>
+{% endfor %}
+
+{% endblock %}
+
+{% block sidebarrel %}
+{% if split_index %}
+   <h4>{{ _('Index') }}</h4>
+   <p>{% for key, dummy in genindexentries -%}
+   <a href="{{ pathto('genindex-' + key) }}"><strong>{{ key }}</strong></a>
+     {% if not loop.last %}| {% endif %}
+   {%- endfor %}</p>
+
+   <p><a href="{{ pathto('genindex-all') }}"><strong>{{ _('Full index on
one page') }}</strong></a></p>
+{% endif %}
+   {{ super() }}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/globaltoc.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/globaltoc.html b/docs/_theme/log4php/globaltoc.html
new file mode 100644
index 0000000..ee191fa
--- /dev/null
+++ b/docs/_theme/log4php/globaltoc.html
@@ -0,0 +1,11 @@
+{#
+    basic/globaltoc.html
+    ~~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: global table of contents.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+{{ toctree() }}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/layout.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/layout.html b/docs/_theme/log4php/layout.html
new file mode 100644
index 0000000..65bd88c
--- /dev/null
+++ b/docs/_theme/log4php/layout.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
+    {{ metatags }}
+
+    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+
+    <link rel="stylesheet" href="{{ pathto('_static/bootstrap/css/bootstrap-2.2.1.css',
1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css"
/>
+    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css"
/>
+    {% if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+    {% endif %}
+    {%- if hasdoc('about') %}
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about')
}}" />
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
+    {%- endif %}
+    {%- if hasdoc('search') %}
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"
/>
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
+    {%- if parents %}
+    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e
}}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+    
+    <script type="text/javascript">
+        var DOCUMENTATION_OPTIONS = {
+            URL_ROOT:    '{{ url_root }}',
+            VERSION:     '{{ release|e }}',
+            COLLAPSE_INDEX: false,
+            FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
+            HAS_SOURCE:  {{ has_source|lower }}
+        };
+    </script>
+    
+    <script type="text/javascript" src="{{ pathto('_static/jquery-1.8.2.min.js', 1) }}"></script>
+    <script type="text/javascript" src="{{ pathto('_static/bootstrap/js/bootstrap-2.2.1.min.js
', 1) }}"></script>
+    <script type="text/javascript" src="{{ pathto('_static/log4php.js', 1) }}"></script>
+</head>
+<body>
+    {%- block header %}{% endblock %}
+
+    {% block relbar1 %}
+    <div class="navbar">
+        <div class="navbar-inner">
+            <div class="container-fluid">
+                <a class="brand" href="http://logging.apache.org/log4php">Apache log4php
&trade;</a>
+                <ul class="nav">
+                    <li><a href="index.html" title="About">About</a></li>
+                    <li><a href="download.html" title="Download">Download</a></li>
+                    <li><a href="install.html" title="Install">Install</a></li>
+                    <li class="active"><a href="{{ pathto(master_doc) }}" title="Docs">Docs</a></li>
+                </ul>
+
+                <!-- Twitter link -->
+                <ul class="nav pull-right">
+                    <li><a href="http://twitter.com/log4php/" class="external">Follow
<strong>@log4php</strong></a></li>
+                </ul>
+
+                <!-- Google CSE Search Box -->
+                <form class="navbar-search pull-right" id="cref" action="http://www.google.com/cse">
+                    <input type="hidden" name="cref" value="http://logging.apache.org/log4php/cse.xml"
/>
+                    <input class="search-query pull-left" type="text" name="q" size="40"
placeholder="Search" />
+                </form>
+            </div>
+        </div>
+    </div>
+    {% endblock %}
+
+    {% block content %}
+    <table class="layout-table">
+        <tr>
+            <td class="sidebar">
+                <div class="well sidebar-nav">
+                    {{ toctree(collapse=False,maxdepth=1) }}
+                </div>
+            </td>
+            <td class="content">
+                <ul class="breadcrumbs">
+                    <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>
&raquo;</li>
+                    {%- for parent in parents %}
+                        <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U")
}}{% endif %}>{{ parent.title }}</a> &raquo;</li>
+                    {%- endfor %}
+                </ul>
+                {% block body %}{% endblock %}
+            </td>
+        </tr>
+    </table>
+    {% endblock %}
+    
+    <div class="footer">
+        <p>
+            Copyright &#169; {{ year }} <a href="http://www.apache.org">Apache
Software Foundation</a>. 
+            All Rights Reserved. Licensed under the 
+            <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache Software License,
Version 2.0</a>. 
+            Please read the <a href="./privacy.html">Privacy policy</a>
+        </p>
+        <p>
+            Apache log4php, Apache, log4php, the Apache feather logo, the Apache Logging
Services 
+            project logo and the Built by Maven logo are trademarks of The Apache Software
Foundation.
+        </p>
+        <p>
+            Site powered by <a class="external" href="http://twitter.github.com/bootstrap/">Twitter
Bootstrap</a>. 
+            Icons from <a class="external" href="http://glyphicons.com/">Glyphicons
Free</a>.
+        </p>
+    </div>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/localtoc.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/localtoc.html b/docs/_theme/log4php/localtoc.html
new file mode 100644
index 0000000..aa612eb
--- /dev/null
+++ b/docs/_theme/log4php/localtoc.html
@@ -0,0 +1,13 @@
+{#
+    basic/localtoc.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: local table of contents.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- if display_toc %}
+  <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+  {{ toc }}
+{%- endif %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/opensearch.xml
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/opensearch.xml b/docs/_theme/log4php/opensearch.xml
new file mode 100644
index 0000000..03875be
--- /dev/null
+++ b/docs/_theme/log4php/opensearch.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>{{ project|e }}</ShortName>
+  <Description>{% trans docstitle=docstitle|e %}Search {{ docstitle }}{% endtrans %}</Description>
+  <InputEncoding>utf-8</InputEncoding>
+  <Url type="text/html" method="get"
+       template="{{ use_opensearch }}/{{ pathto('search') }}?q={searchTerms}&amp;check_keywords=yes&amp;area=default"/>
+  <LongName>{{ docstitle|e }}</LongName>
+{% block extra %} {# Put e.g. an <Image> element here. #} {% endblock %}
+</OpenSearchDescription>

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/page.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/page.html b/docs/_theme/log4php/page.html
new file mode 100644
index 0000000..f6e7a68
--- /dev/null
+++ b/docs/_theme/log4php/page.html
@@ -0,0 +1,13 @@
+{#
+    basic/page.html
+    ~~~~~~~~~~~~~~~
+
+    Master template for simple pages.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{% block body %}
+  {{ body }}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/relations.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/relations.html b/docs/_theme/log4php/relations.html
new file mode 100644
index 0000000..82abbea
--- /dev/null
+++ b/docs/_theme/log4php/relations.html
@@ -0,0 +1,19 @@
+{#
+    basic/relations.html
+    ~~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: relation links.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- if prev %}
+  <h4>{{ _('Previous topic') }}</h4>
+  <p class="topless"><a href="{{ prev.link|e }}"
+                        title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
+{%- endif %}
+{%- if next %}
+  <h4>{{ _('Next topic') }}</h4>
+  <p class="topless"><a href="{{ next.link|e }}"
+                        title="{{ _('next chapter') }}">{{ next.title }}</a></p>
+{%- endif %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/search.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/search.html b/docs/_theme/log4php/search.html
new file mode 100644
index 0000000..4cdc693
--- /dev/null
+++ b/docs/_theme/log4php/search.html
@@ -0,0 +1,56 @@
+{#
+    basic/search.html
+    ~~~~~~~~~~~~~~~~~
+
+    Template for the search page.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{% set title = _('Search') %}
+{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% block extrahead %}
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
+  </script>
+  {{ super() }}
+{% endblock %}
+{% block body %}
+  <h1 id="search-documentation">{{ _('Search') }}</h1>
+  <div id="fallback" class="admonition warning">
+  <script type="text/javascript">$('#fallback').hide();</script>
+  <p>
+    {% trans %}Please activate JavaScript to enable the search
+    functionality.{% endtrans %}
+  </p>
+  </div>
+  <p>
+    {% trans %}From here you can search these documents. Enter your search
+    words into the box below and click "search". Note that the search
+    function will automatically search for all of the words. Pages
+    containing fewer words won't appear in the result list.{% endtrans %}
+  </p>
+  <form action="" method="get">
+    <input type="text" name="q" value="" />
+    <input type="submit" value="{{ _('search') }}" />
+    <span id="search-progress" style="padding-left: 10px"></span>
+  </form>
+  {% if search_performed %}
+    <h2>{{ _('Search Results') }}</h2>
+    {% if not search_results %}
+      <p>{{ _('Your search did not match any results.') }}</p>
+    {% endif %}
+  {% endif %}
+  <div id="search-results">
+  {% if search_results %}
+    <ul>
+    {% for href, caption, context in search_results %}
+      <li><a href="{{ pathto(item.href) }}">{{ caption }}</a>
+        <div class="context">{{ context|e }}</div>
+      </li>
+    {% endfor %}
+    </ul>
+  {% endif %}
+  </div>
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/searchbox.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/searchbox.html b/docs/_theme/log4php/searchbox.html
new file mode 100644
index 0000000..13b453c
--- /dev/null
+++ b/docs/_theme/log4php/searchbox.html
@@ -0,0 +1,24 @@
+{#
+    basic/searchbox.html
+    ~~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: quick search box.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- if pagename != "search" %}
+<div id="searchbox" style="display: none">
+  <h3>{{ _('Quick search') }}</h3>
+    <form class="search" action="{{ pathto('search') }}" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="{{ _('Go') }}" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    {{ _('Enter search terms or a module, class or function name.') }}
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+{%- endif %}

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/searchresults.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/searchresults.html b/docs/_theme/log4php/searchresults.html
new file mode 100644
index 0000000..667abff
--- /dev/null
+++ b/docs/_theme/log4php/searchresults.html
@@ -0,0 +1,36 @@
+{#
+    basic/searchresults.html
+    ~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Template for the body of the search results page.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+<h1 id="search-documentation">Search</h1>
+<p>
+  From here you can search these documents. Enter your search
+  words into the box below and click "search".
+</p>
+<form action="" method="get">
+  <input type="text" name="q" value="" />
+  <input type="submit" value="search" />
+  <span id="search-progress" style="padding-left: 10px"></span>
+</form>
+{%- if search_performed %}
+  <h2>Search Results</h2>
+  {%- if not search_results %}
+  <p>Your search did not match any results.</p>
+  {%- endif %}
+{%- endif %}
+<div id="search-results">
+  {%- if search_results %}
+  <ul class="search">
+    {% for href, caption, context in search_results %}
+    <li><a href="{{ docroot }}{{ href }}/?highlight={{ q }}">{{ caption }}</a>
+      <div class="context">{{ context|e }}</div>
+    </li>
+    {% endfor %}
+  </ul>
+  {%- endif %}
+</div>

http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/4780fc1e/docs/_theme/log4php/sourcelink.html
----------------------------------------------------------------------
diff --git a/docs/_theme/log4php/sourcelink.html b/docs/_theme/log4php/sourcelink.html
new file mode 100644
index 0000000..53f2f6b
--- /dev/null
+++ b/docs/_theme/log4php/sourcelink.html
@@ -0,0 +1,16 @@
+{#
+    basic/sourcelink.html
+    ~~~~~~~~~~~~~~~~~~~~~
+
+    Sphinx sidebar template: "show source" link.
+
+    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- if show_source and has_source and sourcename %}
+  <h3>{{ _('This Page') }}</h3>
+  <ul class="this-page-menu">
+    <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
+           rel="nofollow">{{ _('Show Source') }}</a></li>
+  </ul>
+{%- endif %}


Mime
View raw message