Rev 4569: (igc) Support doc generation via sphinx in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Sat Jul 25 04:40:14 BST 2009
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 4569 [merge]
revision-id: pqm at pqm.ubuntu.com-20090725034012-2fnpljnq7uvk9ss2
parent: pqm at pqm.ubuntu.com-20090724204637-5uutgmi7rx1u8xzp
parent: ian.clatworthy at canonical.com-20090725023720-nzvypcbe8p2rsqji
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Sat 2009-07-25 04:40:12 +0100
message:
(igc) Support doc generation via sphinx
added:
doc/BUILD-NOTES buildnotes-20090722150335-qt9yh29f930m4v0r-3
doc/Makefile makefile-20090722133816-63ik5s6s5gsnz7zy-11
doc/_static/ _static-20090722133816-63ik5s6s5gsnz7zy-1
doc/_static/bzr icon 16.png bzricon16.png-20090722133816-63ik5s6s5gsnz7zy-4
doc/_static/bzr.ico bzr.ico-20090722133816-63ik5s6s5gsnz7zy-5
doc/_static/en/ en-20090722133816-63ik5s6s5gsnz7zy-2
doc/_static/en/quick-reference/ quickreference-20090722133816-63ik5s6s5gsnz7zy-3
doc/_templates/ _templates-20090722133816-63ik5s6s5gsnz7zy-6
doc/_templates/index.html index.html-20090722133849-lus2rzwsmlhpgqhv-1
doc/_templates/layout.html layout.html-20090722133849-lus2rzwsmlhpgqhv-2
doc/conf.py conf.py-20090722133816-63ik5s6s5gsnz7zy-12
doc/contents.txt contents.txt-20090722133816-63ik5s6s5gsnz7zy-13
doc/en/migration/ migration-20090722133816-63ik5s6s5gsnz7zy-7
doc/en/migration/index.txt index.txt-20090722133816-63ik5s6s5gsnz7zy-8
doc/en/quick-reference/index.txt index.txt-20090722133816-63ik5s6s5gsnz7zy-9
doc/en/tutorials/index.txt index.txt-20090722133816-63ik5s6s5gsnz7zy-10
doc/en/user-guide/index-for-2x.txt indexfor2x.txt-20090722150335-qt9yh29f930m4v0r-1
doc/en/user-guide/index.txt@ index.txt-20090722150335-qt9yh29f930m4v0r-2
doc/make.bat make.bat-20090722133816-63ik5s6s5gsnz7zy-14
renamed:
doc/en/quick-reference/Makefile => doc/_static/en/quick-reference/Makefile makefile-20070813143223-5i7bgw7w8s7l3ae2-2
doc/en/quick-reference/quick-start-summary.pdf => doc/_static/en/quick-reference/bzr-quick-reference.pdf quickstartsummary.pd-20071207005239-it6xmdjml8nxvzgt-1
doc/en/quick-reference/quick-start-summary.png => doc/_static/en/quick-reference/bzr-quick-reference.png quickstartsummary.pn-20071203142852-hsiybkmh37q5owwe-1
doc/en/quick-reference/quick-start-summary.svg => doc/_static/en/quick-reference/bzr-quick-reference.svg quickstartsummary.sv-20070813143223-5i7bgw7w8s7l3ae2-3
doc/en/user-guide/index.txt => doc/en/user-guide/index-for-1x.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
modified:
.bzrignore bzrignore-20050311232317-81f7b71efa2db11a
Makefile Makefile-20050805140406-d96e3498bb61c5bb
bzrlib/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
doc/developers/index.txt index.txt-20070508041241-qznziunkg0nffhiw-1
doc/en/tutorials/centralized_workflow.txt centralized_workflow-20060830194948-kspf52565xvgrlil-1
doc/en/tutorials/using_bazaar_with_launchpad.txt using_bazaar_with_lp-20071211073140-7msh8uf9a9h4y9hb-1
doc/en/upgrade-guide/index.txt index.txt-20090702082510-q2pocf7uhntljqnl-3
doc/index.txt index.txt-20070813101924-07gd9i9d2jt124bf-1
doc/_static/en/quick-reference/Makefile makefile-20070813143223-5i7bgw7w8s7l3ae2-2
doc/en/user-guide/index-for-1x.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
=== modified file '.bzrignore'
--- a/.bzrignore 2009-06-23 20:20:39 +0000
+++ b/.bzrignore 2009-07-22 13:41:01 +0000
@@ -7,6 +7,7 @@
CHANGELOG
bzr.1
./doc/*.html
+./doc/_build/
./tutorial.html
BRANCH-INFO
# setup.py working directory
=== modified file 'Makefile'
--- a/Makefile 2009-07-20 11:27:05 +0000
+++ b/Makefile 2009-07-22 14:07:56 +0000
@@ -89,7 +89,11 @@
derived_txt_files := \
doc/en/user-reference/bzr_man.txt \
doc/en/release-notes/NEWS.txt
-txt_files := $(wildcard doc/*/tutorials/*.txt) \
+txt_files := \
+ doc/en/tutorials/tutorial.txt \
+ doc/en/tutorials/using_bazaar_with_launchpad.txt \
+ doc/en/tutorials/centralized_workflow.txt \
+ $(wildcard doc/ru/tutorials/*.txt) \
$(wildcard doc/*/mini-tutorial/index.txt) \
$(wildcard doc/*/user-guide/index.txt) \
$(derived_txt_files) \
@@ -101,9 +105,9 @@
$(wildcard doc/index.*.txt)
non_txt_files := \
doc/default.css \
- $(wildcard doc/*/quick-reference/quick-start-summary.svg) \
- $(wildcard doc/*/quick-reference/quick-start-summary.png) \
- $(wildcard doc/*/quick-reference/quick-start-summary.pdf) \
+ $(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
+ $(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
+ $(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
$(wildcard doc/*/user-guide/images/*.png)
htm_files := $(patsubst %.txt, %.html, $(txt_files))
=== modified file 'bzrlib/doc_generate/autodoc_rstx.py'
--- a/bzrlib/doc_generate/autodoc_rstx.py 2009-06-19 10:00:56 +0000
+++ b/bzrlib/doc_generate/autodoc_rstx.py 2009-07-22 14:36:38 +0000
@@ -163,7 +163,7 @@
:Version: %(version)s
:Generated: %(datestamp)s
-.. contents:: :depth: 2
+.. contents:: :depth: 3
-----
=== added file 'doc/BUILD-NOTES'
--- a/doc/BUILD-NOTES 1970-01-01 00:00:00 +0000
+++ b/doc/BUILD-NOTES 2009-07-22 15:04:22 +0000
@@ -0,0 +1,35 @@
+To build Bazaar's documentation using Sphinx, follow the
+steps below.
+
+0. Install Sphinx. You'll need Sphinx 0.6 or later. If that
+ version isn't available in your package manager repositories
+ yet, install python-easyinstall and use it to install Sphinx.
+ See http://sphinx.pocoo.org/ for details.
+
+1. Build the Bazaar docs normally, i.e. in the project root, run:
+
+ make docs
+
+2. Tweak the User Guide index page used:
+
+ cd doc/en/user-guide
+ rm index.txt
+ ln -s index-for-2x.txt index.txt
+
+3. Tweak the Release Notes TOC depth:
+
+ cd ../release-notes
+ vi NEWS.txt (change depth to 2)
+
+4. Change to the docs directory and build the site:
+
+ cd ../..
+ make html
+
+The generated output site can be found in _build/html.
+
+Note: All of the above will Just Work soon. For now, we don't
+want to break the existing doc generation until a few issues
+with the Sphinx-generated site are ironed out, e.g. links from
+the User Reference to ../user-guide/index.html#foo no longer
+work when the User Guide is nicely split into topic pages.
=== added file 'doc/Makefile'
--- a/doc/Makefile 1970-01-01 00:00:00 +0000
+++ b/doc/Makefile 2009-07-22 13:41:01 +0000
@@ -0,0 +1,88 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d _build/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 _build/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+ @echo
+ @echo "Build finished. The HTML pages are in _build/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in _build/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in _build/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in _build/qthelp, like this:"
+ @echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in _build/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+ @echo
+ @echo "The overview file is in _build/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in _build/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in _build/doctest/output.txt."
=== added directory 'doc/_static'
=== added file 'doc/_static/bzr icon 16.png'
Binary files a/doc/_static/bzr icon 16.png 1970-01-01 00:00:00 +0000 and b/doc/_static/bzr icon 16.png 2009-07-22 13:41:01 +0000 differ
=== added file 'doc/_static/bzr.ico'
Binary files a/doc/_static/bzr.ico 1970-01-01 00:00:00 +0000 and b/doc/_static/bzr.ico 2009-07-22 13:41:01 +0000 differ
=== added directory 'doc/_static/en'
=== added directory 'doc/_static/en/quick-reference'
=== renamed file 'doc/en/quick-reference/Makefile' => 'doc/_static/en/quick-reference/Makefile'
--- a/doc/en/quick-reference/Makefile 2009-06-10 09:19:20 +0000
+++ b/doc/_static/en/quick-reference/Makefile 2009-07-22 14:07:56 +0000
@@ -2,8 +2,8 @@
# doc/*/quick-reference/Makefile and update TARGETS and OBJECTS usages in
# doc/Makefile
-TARGETS=quick-start-summary.png quick-start-summary.pdf
-OBJECTS=quick-start-summary.svg Makefile
+TARGETS=bzr-quick-reference.png bzr-quick-reference.pdf
+OBJECTS=bzr-quick-reference.svg Makefile
all: $(TARGETS)
=== renamed file 'doc/en/quick-reference/quick-start-summary.pdf' => 'doc/_static/en/quick-reference/bzr-quick-reference.pdf'
=== renamed file 'doc/en/quick-reference/quick-start-summary.png' => 'doc/_static/en/quick-reference/bzr-quick-reference.png'
=== renamed file 'doc/en/quick-reference/quick-start-summary.svg' => 'doc/_static/en/quick-reference/bzr-quick-reference.svg'
=== added directory 'doc/_templates'
=== added file 'doc/_templates/index.html'
--- a/doc/_templates/index.html 1970-01-01 00:00:00 +0000
+++ b/doc/_templates/index.html 2009-07-22 14:36:38 +0000
@@ -0,0 +1,62 @@
+{% extends "layout.html" %}
+
+{% set title = 'Table of Contents' %}
+{% block body %}
+
+ <h2>Core documentation</h2>
+
+ <table class="contentstable" align="center" style="margin-left: 30px"><tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/user-guide/index") }}">User Guide</a><br/>
+ <span class="linkdescr">how to use Bazaar effectively</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/tutorials/index") }}">Tutorials</a><br/>
+ <span class="linkdescr">brief introductions</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/quick-reference/index") }}">Quick Reference</a><br/>
+ <span class="linkdescr">for your wall</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/user-reference/bzr_man") }}">User Reference</a><br/>
+ <span class="linkdescr">all the gory details</span>
+ </p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/release-notes/NEWS") }}">Release Notes</a><br/>
+ <span class="linkdescr">what's new</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/upgrade-guide/index") }}">Upgrade Guide</a><br/>
+ <span class="linkdescr">moving to Bazaar 2.x</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("en/migration/index") }}">Migration Docs</a><br/>
+ <span class="linkdescr">for refugees of other tools</span>
+ </p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("developers/index") }}">Developer Docs</a><br/>
+ <span class="linkdescr">polices and tools for giving back</span>
+ </p>
+ </td></tr>
+ </table>
+
+ <p>Other languages:
+ <a href="{{ pathto("index.es") }}">Spanish</a>,
+ <a href="{{ pathto("index.ru") }}">Russian</a>
+ </p>
+
+
+ <h2>Related Links</h2>
+
+ <table class="contentstable" align="center" style="margin-left: 30px"><tr>
+ <td width="25%">
+ <p><a href="https://answers.launchpad.net/bzr">FAQ</a>
+ </p>
+ </td><td width="25%">
+ <p><a href="http://bazaar-vcs.org/BzrGlossary/">Glossary</a>
+ </p>
+ </td><td width="25%">
+ <p><a href="{{ pathto("genindex") }}">Index</a>
+ </p>
+ </td><td width="25%">
+ <p><a href="{{ pathto("search") }}">Search</a>
+ </p>
+ </td></tr>
+ </table>
+
+{% endblock %}
=== added file 'doc/_templates/layout.html'
--- a/doc/_templates/layout.html 1970-01-01 00:00:00 +0000
+++ b/doc/_templates/layout.html 2009-07-22 13:41:01 +0000
@@ -0,0 +1,7 @@
+{% extends "!layout.html" %}
+
+{% block rootrellink %}
+<li><a href="http://bazaar-vcs.org/">
+ <img src="{{ pathto("_static/bzr icon 16.png", 1) }}" /> Home</a> | </li>
+{{ super() }}
+{% endblock %}
=== added file 'doc/conf.py'
--- a/doc/conf.py 1970-01-01 00:00:00 +0000
+++ b/doc/conf.py 2009-07-22 13:41:01 +0000
@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+#
+# Bazaar documentation build configuration file, created by
+# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
+#
+# 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.ifconfig']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'Bazaar'
+copyright = u'2009, Canonical Ltd'
+
+# 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 = '1.18'
+# The full version, including alpha/beta/rc tags.
+release = '1.18dev'
+
+# 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 = {
+ 'rightsidebar': True,
+
+ # Non-document areas: header (relbar), footer, sidebar, etc.
+ # Some useful colours here:
+ # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
+ # midnightblue
+ # * gray: dimgray, slategray, lightslategray
+ 'sidebarbgcolor': "cornflowerblue",
+ 'sidebarlinkcolor': "midnightblue",
+ 'relbarbgcolor': "darkblue",
+ 'footerbgcolor': "lightslategray",
+
+ # Text, heading and code colouring
+ 'codebgcolor': "lightyellow",
+ 'codetextcolor': "firebrick",
+ 'linkcolor': "mediumblue",
+ }
+
+# 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 = "bzr.ico"
+
+# 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 = {'contents': 'index.html'}
+
+# 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 = 'Bazaardoc'
+
+
+# -- 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 = [
+ ('contents', 'Bazaar.tex', u'Bazaar Documentation',
+ u'Bazaar Developers', '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 file 'doc/contents.txt'
--- a/doc/contents.txt 1970-01-01 00:00:00 +0000
+++ b/doc/contents.txt 2009-07-22 13:41:01 +0000
@@ -0,0 +1,43 @@
+.. Bazaar documentation master file, created by
+ sphinx-quickstart on Tue Jul 21 17:04:52 2009.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+
+Core documentation
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ en/user-guide/index
+ en/tutorials/index
+ en/quick-reference/index
+ en/user-reference/index
+
+.. toctree::
+ :maxdepth: 1
+
+ en/release-notes/index
+ en/upgrade-guide/index
+ en/migration/index
+ developers/index
+
+
+Other languages:
+
+.. toctree::
+ :maxdepth: 1
+
+ index.es
+ index.ru
+
+
+Related links
+=============
+
+* `Frequently Asked Questions <http://bazaar-vcs.org/FAQ>`_
+* `Glossary <http://bazaar-vcs.org/BzrGlossary>`_
+* :ref:`genindex`
+* :ref:`search`
+
=== modified file 'doc/developers/index.txt'
--- a/doc/developers/index.txt 2009-06-15 07:22:59 +0000
+++ b/doc/developers/index.txt 2009-07-22 13:41:01 +0000
@@ -2,8 +2,6 @@
Bazaar Developer Document Catalog
=================================
-Bazaar user documentation is in the
-`Main Document Catalog <../index.html>`_.
Overall developer documentation
===============================
=== added directory 'doc/en/migration'
=== added file 'doc/en/migration/index.txt'
--- a/doc/en/migration/index.txt 1970-01-01 00:00:00 +0000
+++ b/doc/en/migration/index.txt 2009-07-22 13:41:01 +0000
@@ -0,0 +1,6 @@
+Bazaar Migration Guide
+======================
+
+This guide is under development. For notes collected so far, see
+http://bazaar-vcs.org/BzrMigration/.
+
=== added file 'doc/en/quick-reference/index.txt'
--- a/doc/en/quick-reference/index.txt 1970-01-01 00:00:00 +0000
+++ b/doc/en/quick-reference/index.txt 2009-07-22 14:07:56 +0000
@@ -0,0 +1,6 @@
+Quick Reference
+===============
+
+* `SVG format <../../_static/en/quick-reference/bzr-quick-reference.svg>`_
+* `PDF format <../../_static/en/quick-reference/bzr-quick-reference.pdf>`_
+* `PNG format <../../_static/en/quick-reference/bzr-quick-reference.png>`_
=== modified file 'doc/en/tutorials/centralized_workflow.txt'
--- a/doc/en/tutorials/centralized_workflow.txt 2007-11-28 00:07:56 +0000
+++ b/doc/en/tutorials/centralized_workflow.txt 2009-07-22 13:41:01 +0000
@@ -2,8 +2,6 @@
Centralized Workflow
====================
-.. sectnum::
-
Overview
========
=== added file 'doc/en/tutorials/index.txt'
--- a/doc/en/tutorials/index.txt 1970-01-01 00:00:00 +0000
+++ b/doc/en/tutorials/index.txt 2009-07-22 13:41:01 +0000
@@ -0,0 +1,11 @@
+Tutorials
+=========
+
+.. toctree::
+ :maxdepth: 1
+
+ ../mini-tutorial/index
+ tutorial
+ using_bazaar_with_launchpad
+ centralized_workflow
+
=== modified file 'doc/en/tutorials/using_bazaar_with_launchpad.txt'
--- a/doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-05-31 11:46:02 +0000
+++ b/doc/en/tutorials/using_bazaar_with_launchpad.txt 2009-07-22 13:41:01 +0000
@@ -3,7 +3,7 @@
===========================
.. contents::
-.. sectnum::
+
Motivation
==========
=== modified file 'doc/en/upgrade-guide/index.txt'
--- a/doc/en/upgrade-guide/index.txt 2009-07-13 06:58:49 +0000
+++ b/doc/en/upgrade-guide/index.txt 2009-07-22 13:41:01 +0000
@@ -8,9 +8,7 @@
.. level 3 ~~~~~~~~
.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
-.. contents:: :depth: 2
-.. sectnum::
-
+.. contents::
.. include:: overview.txt
.. include:: data_migration.txt
=== renamed file 'doc/en/user-guide/index.txt' => 'doc/en/user-guide/index-for-1x.txt'
--- a/doc/en/user-guide/index.txt 2009-03-12 06:04:54 +0000
+++ b/doc/en/user-guide/index-for-1x.txt 2009-07-22 15:04:22 +0000
@@ -2,16 +2,13 @@
Bazaar User Guide
#################
-.. Files are currently links but will become includes once the
-.. content makes more sense as a whole.
-.. Please mark sections in linked/included files as following:
+.. Please mark sections in included files as following:
.. level 1 ========
.. level 2 --------
.. level 3 ~~~~~~~~
.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
-.. contents:: :depth: 2
-.. sectnum::
+.. contents:: :depth: 3
Introduction
=== added file 'doc/en/user-guide/index-for-2x.txt'
--- a/doc/en/user-guide/index-for-2x.txt 1970-01-01 00:00:00 +0000
+++ b/doc/en/user-guide/index-for-2x.txt 2009-07-22 15:04:22 +0000
@@ -0,0 +1,141 @@
+#################
+Bazaar User Guide
+#################
+
+.. Please mark sections in included files as following:
+.. level 1 ========
+.. level 2 --------
+.. level 3 ~~~~~~~~
+.. level 4 ^^^^^^^^ (it is better not to use nesting deeper than 3 levels)
+
+
+Introduction
+############
+
+.. toctree::
+ :maxdepth: 1
+
+ introducing_bazaar
+ core_concepts
+ bazaar_workflows
+
+
+Getting started
+###############
+
+.. toctree::
+ :maxdepth: 1
+
+ installing_bazaar
+ entering_commands
+ getting_help
+ configuring_bazaar
+ using_aliases
+ plugins
+ zen
+
+
+Personal version control
+########################
+
+.. toctree::
+ :maxdepth: 1
+
+ solo_intro
+ starting_a_project
+ controlling_registration
+ reviewing_changes
+ recording_changes
+ browsing_history
+ releasing_a_project
+ undoing_mistakes
+
+
+Sharing with peers
+##################
+
+.. toctree::
+ :maxdepth: 1
+
+ partner_intro
+ branching_a_project
+ merging_changes
+ resolving_conflicts
+ annotating_changes
+
+
+Team collaboration, central style
+#################################
+
+.. toctree::
+ :maxdepth: 1
+
+ central_intro
+ publishing_a_branch
+ using_checkouts
+ working_offline_central
+ reusing_a_checkout
+
+
+Team collaboration, distributed style
+#####################################
+
+.. toctree::
+ :maxdepth: 1
+
+ distributed_intro
+ organizing_branches
+ using_gatekeepers
+ sending_changes
+
+
+Miscellaneous topics
+####################
+
+.. toctree::
+ :maxdepth: 1
+
+ part2_intro
+ adv_merging
+ shelving_changes
+ filtered_views
+ stacked
+ server
+ hooks
+ version_info
+
+
+A brief tour of some popular plugins
+####################################
+
+.. toctree::
+ :maxdepth: 1
+
+ bzrtools_plugin
+ svn_plugin
+
+
+Integrating Bazaar into your environment
+########################################
+
+.. toctree::
+ :maxdepth: 1
+
+ web_browsing
+ bug_trackers
+
+
+Appendices
+##########
+
+.. toctree::
+ :maxdepth: 1
+
+ specifying_revisions
+ organizing_your_workspace
+ shared_repository_layouts
+ setting_up_email
+ http_smart_server
+ writing_a_plugin
+
+.. |--| unicode:: U+2014
=== added symlink 'doc/en/user-guide/index.txt'
=== target is 'index-for-1x.txt'
=== modified file 'doc/index.txt'
--- a/doc/index.txt 2009-07-02 08:26:00 +0000
+++ b/doc/index.txt 2009-07-22 14:07:56 +0000
@@ -13,9 +13,9 @@
* `User Reference <en/user-reference/bzr_man.html>`_
-* `Quick Start Card <en/quick-reference/quick-start-summary.svg>`_
- (`PDF <en/quick-reference/quick-start-summary.pdf>`_,
- `PNG <en/quick-reference/quick-start-summary.png>`_)
+* `Quick Start Card <_static/en/quick-reference/bzr-quick-reference.svg>`_
+ (`PDF <_static/en/quick-reference/bzr-quick-reference.pdf>`_,
+ `PNG <_static/en/quick-reference/bzr-quick-reference.png>`_)
* `Release Notes <en/release-notes/NEWS.html>`_
=== added file 'doc/make.bat'
--- a/doc/make.bat 1970-01-01 00:00:00 +0000
+++ b/doc/make.bat 2009-07-22 13:41:01 +0000
@@ -0,0 +1,112 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :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 over 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
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (_build\*) do rmdir /q /s %%i
+ del /q /s _build\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
+ echo.
+ echo.Build finished. The HTML pages are in _build/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml
+ echo.
+ echo.Build finished. The HTML pages are in _build/dirhtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in _build/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in _build/qthelp, like this:
+ echo.^> qcollectiongenerator _build\qthelp\Bazaar.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile _build\qthelp\Bazaar.ghc
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex
+ echo.
+ echo.Build finished; the LaTeX files are in _build/latex.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
+ echo.
+ echo.The overview file is in _build/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in _build/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in _build/doctest/output.txt.
+ goto end
+)
+
+:end
More information about the bazaar-commits
mailing list