r4696 - in trunk/varnish-cache/doc: . sphinx sphinx/installation sphinx/reference sphinx/tutorial
phk at varnish-cache.org
phk at varnish-cache.org
Tue Apr 20 15:15:11 CEST 2010
Author: phk
Date: 2010-04-20 15:15:09 +0200 (Tue, 20 Apr 2010)
New Revision: 4696
Added:
trunk/varnish-cache/doc/sphinx/
trunk/varnish-cache/doc/sphinx/=build/
trunk/varnish-cache/doc/sphinx/=static/
trunk/varnish-cache/doc/sphinx/=templates/
trunk/varnish-cache/doc/sphinx/Makefile
trunk/varnish-cache/doc/sphinx/conf.py
trunk/varnish-cache/doc/sphinx/index.rst
trunk/varnish-cache/doc/sphinx/installation/
trunk/varnish-cache/doc/sphinx/installation/index.rst
trunk/varnish-cache/doc/sphinx/reference/
trunk/varnish-cache/doc/sphinx/reference/index.rst
trunk/varnish-cache/doc/sphinx/tutorial/
trunk/varnish-cache/doc/sphinx/tutorial/index.rst
Log:
Add a Sphinx directory and my outlines for three varnish documents:
installation, tutorial and reference.
Please feel free to help flesh these out.
See http://sphinx.pocoo.org for more on the tool we are using.
To build html version, go into doc/sphinx and type "make html"
result should end up under the =build subdirectory.
Added: trunk/varnish-cache/doc/sphinx/Makefile
===================================================================
--- trunk/varnish-cache/doc/sphinx/Makefile (rev 0)
+++ trunk/varnish-cache/doc/sphinx/Makefile 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,89 @@
+# 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) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @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."
+
+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/Varnish.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Varnish.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+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."
Added: trunk/varnish-cache/doc/sphinx/conf.py
===================================================================
--- trunk/varnish-cache/doc/sphinx/conf.py (rev 0)
+++ trunk/varnish-cache/doc/sphinx/conf.py 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# Varnish documentation build configuration file, created by
+# sphinx-quickstart on Tue Apr 20 13:02:15 2010.
+#
+# 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.
+
+import sys, os
+
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# 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.todo']
+
+# 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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Varnish'
+copyright = u'2010, Varnish Project'
+
+# 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 = '-trunk'
+# The full version, including alpha/beta/rc tags.
+release = '-trunk'
+
+# 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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['=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 = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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']
+
+# 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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Varnishdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Varnish.tex', u'Varnish Documentation',
+ u'Varnish Project', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
Added: trunk/varnish-cache/doc/sphinx/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/index.rst (rev 0)
+++ trunk/varnish-cache/doc/sphinx/index.rst 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,24 @@
+.. Varnish documentation master file, created by
+ sphinx-quickstart on Tue Apr 20 13:02:15 2010.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Varnish's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation/index.rst
+ tutorial/index.rst
+ reference/index.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Added: trunk/varnish-cache/doc/sphinx/installation/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/installation/index.rst (rev 0)
+++ trunk/varnish-cache/doc/sphinx/installation/index.rst 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,19 @@
+%%%%%%%%%%%%%%%%%%%%
+Varnish Installation
+%%%%%%%%%%%%%%%%%%%%
+
+.. todo::
+ on this os, pull this package
+ .. that ..//..
+ to compile from source
+ how to get help
+ - mailing list
+ - IRC
+ - varnish-software.com
+ - other listed consultants
+ reporting bugs
+ - using varnishtest to reproduce
+ - what data do we need
+ - confidentiality
+ - ...
+
Added: trunk/varnish-cache/doc/sphinx/reference/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/index.rst (rev 0)
+++ trunk/varnish-cache/doc/sphinx/reference/index.rst 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,35 @@
+%%%%%%%%%%%%%%%%%%%%%
+The Varnish Reference
+%%%%%%%%%%%%%%%%%%%%%
+
+.. todo::
+ The programs:
+ . varnishd manual page
+ . varnishstat
+ . - counters explained
+ . common filtering options for shmlog tools
+ . varnishlog ..
+ . varnsihtop ..
+ . varnsihncsa ..
+ . varnsihhist ..
+ The CLI:
+ . connections: -T -S -M
+ . varnishadm
+ . CLI commands and what they do
+ . - vcl.load
+ . - stop
+ . - start
+ . - ...
+ VCL language
+ . The functions:
+ . - vcl_recv
+ . - vcl_miss
+ . ---
+ . The things you can do
+ . - set
+ . - unset
+ . - esi
+ . - rollback
+ Varnishtest
+ . syntax etc.
+
Added: trunk/varnish-cache/doc/sphinx/tutorial/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/tutorial/index.rst (rev 0)
+++ trunk/varnish-cache/doc/sphinx/tutorial/index.rst 2010-04-20 13:15:09 UTC (rev 4696)
@@ -0,0 +1,25 @@
+%%%%%%%%%%%%%%%%
+Varnish Tutorial
+%%%%%%%%%%%%%%%%
+
+.. todo::
+ starting varnish with -d, seeing a transaction go through
+ explain varnishlog output for a miss and a hit
+ a few simple VCL tricks, including switching VCL on the fly
+ The helpers: varnishstat, varnishhist, varnishtop varnishncsa
+ Now that you know how it works, lets talk planning:
+ - backend, directors and polling
+ - storage
+ - logging
+ - management CLI & security
+ - ESI
+ Real life examples:
+ - A real life varnish explained
+ - A more complex real life varnish explained
+ - Sky's Wikia Setup
+ Varnishtest
+ - What varnishtest does and why
+ - writing simple test-cases
+ - using varnishtest to test your VCL
+ - using varnishtest to reproduce bugs
+
More information about the varnish-commit
mailing list