Merge lp:~jelmer/brz/docs-on-homepage into lp:brz

Proposed by Jelmer Vernooij
Status: Merged
Approved by: Jelmer Vernooij
Approved revision: no longer in the source branch.
Merge reported by: The Breezy Bot
Merged at revision: not available
Proposed branch: lp:~jelmer/brz/docs-on-homepage
Merge into: lp:brz
Diff against target: 193 lines (+21/-29)
7 files modified
breezy/doc_generate/autodoc_rstx.py (+5/-5)
breezy/doc_generate/conf.py (+2/-2)
doc/en/admin-guide/index-plain.txt (+1/-1)
doc/en/admin-guide/index.txt (+1/-1)
doc/en/conf.py (+2/-2)
doc/index.txt (+7/-15)
tools/generate_release_notes.py (+3/-3)
To merge this branch: bzr merge lp:~jelmer/brz/docs-on-homepage
Reviewer Review Type Date Requested Status
Martin Packman Approve
Review via email: mp+358952@code.launchpad.net

Commit message

Some improvements to the documentation.

Description of the change

Some improvements to the documentation.

Replace Bazaar with Breezy in a few places.
Pick a new Sphinx theme.

To post a comment you must log in.
Revision history for this message
Martin Packman (gz) wrote :

Thanks!

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'breezy/doc_generate/autodoc_rstx.py'
2--- breezy/doc_generate/autodoc_rstx.py 2018-11-11 04:08:32 +0000
3+++ breezy/doc_generate/autodoc_rstx.py 2018-11-18 10:41:41 +0000
4@@ -17,7 +17,7 @@
5 """Generate reStructuredText source for the User Reference Manual.
6 Loosely based on the manpage generator autodoc_man.py.
7
8-Written by the Bazaar community.
9+Written by the Bazaar/Breezy community.
10 """
11
12 from __future__ import absolute_import
13@@ -149,13 +149,13 @@
14
15 rstx_head = """\
16 #####################
17-Bazaar User Reference
18+Breezy User Reference
19 #####################
20
21 About This Manual
22 #################
23
24-This manual is generated from Bazaar's online help. To use
25+This manual is generated from Breezy's online help. To use
26 the online help system, try the following commands.
27
28 Introduction including a list of commonly used commands::
29@@ -174,10 +174,10 @@
30
31 brz help topic-or-command-name
32
33-The following web sites provide further information on Bazaar:
34+The following web sites provide further information on Breezy:
35
36 :Home page: http://www.breezy-vcs.org/
37-:Bazaar docs: http://doc.bazaar.canonical.com/
38+:Breezy docs: http://www.breezy-vcs.org/doc/
39 :Launchpad: https://launchpad.net/brz/
40 """
41
42
43=== modified file 'breezy/doc_generate/conf.py'
44--- breezy/doc_generate/conf.py 2018-11-11 04:08:32 +0000
45+++ breezy/doc_generate/conf.py 2018-11-18 10:41:41 +0000
46@@ -37,7 +37,7 @@
47
48 # General information about the project.
49 project = u'Breezy'
50-copyright = u'2009-2011 Canonical Ltd'
51+copyright = u'2009-2011 Canonical Ltd, 2017-2018 Breezy Developers'
52
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55@@ -91,7 +91,7 @@
56
57 # The theme to use for HTML and HTML Help pages. Major themes that come with
58 # Sphinx are currently 'default' and 'sphinxdoc'.
59-html_theme = 'default'
60+html_theme = 'agogo'
61
62 # Theme options are theme-specific and customize the look and feel of a theme
63 # further. For a list of options available for each theme, see the
64
65=== modified file 'doc/en/admin-guide/index-plain.txt'
66--- doc/en/admin-guide/index-plain.txt 2011-05-16 10:05:25 +0000
67+++ doc/en/admin-guide/index-plain.txt 2018-11-18 10:41:41 +0000
68@@ -1,5 +1,5 @@
69 ###################################
70-Bazaar System Administrator's Guide
71+Breezy System Administrator's Guide
72 ###################################
73
74 .. Please mark sections in included files as following:
75
76=== modified file 'doc/en/admin-guide/index.txt'
77--- doc/en/admin-guide/index.txt 2011-05-16 10:05:25 +0000
78+++ doc/en/admin-guide/index.txt 2018-11-18 10:41:41 +0000
79@@ -1,5 +1,5 @@
80 ###################################
81-Bazaar System Administrator's Guide
82+Breezy System Administrator's Guide
83 ###################################
84
85 .. Please mark sections in included files as following:
86
87=== modified file 'doc/en/conf.py'
88--- doc/en/conf.py 2018-11-16 13:05:23 +0000
89+++ doc/en/conf.py 2018-11-18 10:41:41 +0000
90@@ -72,8 +72,8 @@
91 ('tutorials/centralized_workflow',
92 'brz-%s-tutorial-centralized' % (brz_locale,),
93 brz_title(u'Centralized Workflow Tutorial'), brz_team, 'howto'),
94- ('whats-new/whats-new-in-2.1', 'brz-%s-whats-new' % (brz_locale,),
95- brz_title(u"What's New in Breezy 2.1?"), brz_team, 'howto'),
96+ ('whats-new/whats-new-in-3.0', 'brz-%s-whats-new' % (brz_locale,),
97+ brz_title(u"What's New in Breezy 3.0?"), brz_team, 'howto'),
98 ]
99
100 latex_documents = [
101
102=== modified file 'doc/index.txt'
103--- doc/index.txt 2010-08-17 06:45:33 +0000
104+++ doc/index.txt 2018-11-18 10:41:41 +0000
105@@ -1,9 +1,9 @@
106 ============================
107-Bazaar Main Document Catalog
108+Breezy Main Document Catalog
109 ============================
110
111-The latest version of these documents are available from Bazaar's
112-documentation site, <http://doc.bazaar.canonical.com/>, and more documentation
113+The latest version of these documents are available from Breezy's
114+documentation site, <http://doc.breezy.canonical.com/>, and more documentation
115 may be linked from <http://wiki.bazaar.canonical.com/Documentation>.
116
117 Core Documentation
118@@ -19,17 +19,17 @@
119
120 * `Release Notes <en/release-notes/NEWS.html>`_
121
122-* `2.0 Upgrade Guide <en/upgrade-guide/index.html>`_
123+* `3.0 Upgrade Guide <en/upgrade-guide/index.html>`_
124
125
126 Tutorials
127 =========
128
129-* `Bazaar in five minutes <en/mini-tutorial/index.html>`_
130+* `Breezy in five minutes <en/mini-tutorial/index.html>`_
131
132 * `A longer tutorial <en/tutorials/tutorial.html>`_
133
134-* `Using Bazaar with Launchpad <en/tutorials/using_bazaar_with_launchpad.html>`_
135+* `Using Breezy with Launchpad <en/tutorials/using_breezy_with_launchpad.html>`_
136
137 * `Centralized workflow <en/tutorials/centralized_workflow.html>`_
138
139@@ -38,7 +38,7 @@
140 =======================
141
142 * `Developer Document Catalog <developers/index-plain.html>`_ |--| for developers
143- of Bazaar and plugins
144+ of Breezy and plugins
145
146 Web links
147 =========
148@@ -53,14 +53,6 @@
149
150 * `Frequently Asked Questions <http://wiki.bazaar.canonical.com/FAQ>`_
151
152-
153-Other Languages
154-===============
155-
156-* `Spanish Documentation <index.es.html>`_
157-* `Russian Documentation <index.ru.html>`_ |--| документация на русском
158-* `Japanese Documentation <index.ja.html>`_ |--| 日本語のドキュメント
159-
160 .. |--| unicode:: U+2014
161
162 ..
163
164=== modified file 'tools/generate_release_notes.py'
165--- tools/generate_release_notes.py 2018-05-07 12:48:12 +0000
166+++ tools/generate_release_notes.py 2018-11-18 10:41:41 +0000
167@@ -35,7 +35,7 @@
168
169 preamble_plain = """\
170 ####################
171-Bazaar Release Notes
172+Breezy Release Notes
173 ####################
174
175
176@@ -46,7 +46,7 @@
177
178 preamble_sphinx = """\
179 ####################
180-Bazaar Release Notes
181+Breezy Release Notes
182 ####################
183
184
185@@ -92,7 +92,7 @@
186 for line in lines:
187 if line == '####################\n':
188 line = '#' * len(title) + '\n'
189- elif line == 'Bazaar Release Notes\n':
190+ elif line == 'Breezy Release Notes\n':
191 line = title + '\n'
192 elif line == '.. toctree::\n':
193 continue

Subscribers

People subscribed via source and target branches