/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to generate_docs.py

  • Committer: Robert Collins
  • Date: 2007-04-18 08:39:02 UTC
  • mto: (2425.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 2427.
  • Revision ID: robertc@robertcollins.net-20070418083902-4o66h9fk7zeisvwa
Command objects can now declare related help topics by having _see_also
set to a list of related topic. Updated the HACKING guide entry on
documentation to be more clear about how the help for commands is
generated and to reference this new feature. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
generate_docs.py
1
1
#!/usr/bin/python
2
2
 
3
3
# Copyright 2005 Canonical Ltd.
4
 
 
 
4
#
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
9
 
 
 
9
#
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
13
# GNU General Public License for more details.
14
 
 
 
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
18
19
"""%(prog)s - generate information from built-in bzr help
19
20
 
20
21
%(prog)s creates a file with information on bzr in one of
38
39
import tools.doc_generate
39
40
 
40
41
def main(argv):
41
 
    parser = OptionParser(usage="%prog [options] OUTPUT_FORMAT")
 
42
    parser = OptionParser(usage="""%prog [options] OUTPUT_FORMAT
 
43
 
 
44
Available OUTPUT_FORMAT:
 
45
 
 
46
    man              man page
 
47
    rstx             man page in ReStructuredText format
 
48
    bash_completion  bash completion script""")
42
49
 
43
50
    parser.add_option("-s", "--show-filename",
44
51
                      action="store_true", dest="show_filename", default=False,