← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to generate_docs.py

  • Committer: James Blackwell
  • Date: 2005-12-12 01:26:27 UTC
  • mto: (1185.50.63 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: jblack@pluto-20051212012627-a5637b074fce751b
Final wrapup on doc generation

Show diffs side-by-side

added added

removed removed

Lines of Context:
generate_docs.py
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
 
 
19
 
"""bzr-infogen.py - generate information from built-in bzr help
20
 
 
21
 
bzr-infogen.py creates a file with information on bzr in one of
22
 
several different output formats:\n
 
18
"""%(prog)s - generate information from built-in bzr help
 
19
 
 
20
%(prog)s creates a file with information on bzr in one of
 
21
several different output formats:
23
22
 
24
23
    man              man page
25
24
    bash_completion  bash completion script
26
25
    ...
27
26
 
28
 
Run "bzr-infogen.py --help" for usage information.
 
27
Examples: 
 
28
 
 
29
    python2.4 generated-docs.py man
 
30
    python2.4 generated-docs.py bash_completion
 
31
 
 
32
Run "%(prog)s --help" for the option reference.
29
33
"""
30
34
 
31
35
# Plan (devised by jblack and ndim 2005-12-10):
32
36
#   * one generate_doc.py script in top level dir right beside bzr
33
 
#   * one doc_generate/ directory (python module)
 
37
#   * one tools/doc_generate/ directory (python module)
34
38
#     We did not put the stuff into bzrlib because we thought
35
39
#     that all this stuff doesn't need to get loaded every time you run bzr.
36
40
#     However, I'm not sure that is actually true (ndim 2005-12-11).
37
41
#   * several generator scripts like
38
 
#           doc_generate/autodoc_man_page.py
39
 
#                        autodoc_docbook_xml.py
40
 
#                        autodoc_html.py
41
 
#                        autodoc_bash_completion.py
42
 
#                        autodoc_zsh_completion.py
 
42
#           tools/doc_generate/autodoc_man_page.py
 
43
#                              autodoc_docbook_xml.py
 
44
#                              autodoc_html.py
 
45
#                              autodoc_bash_completion.py
 
46
#                              autodoc_zsh_completion.py
43
47
#   * scripts are called by running something like
44
48
#     "python2.4 generated_docs.py --man-page"         or
45
49
#     "python2.4 generated_docs.py --bash-completion"   or
54
58
 
55
59
 
56
60
import sys
57
 
import doc_generate
58
 
 
59
 
descr = """generated-docs.py creates a file with information on bzr in a variety
60
 
of output formats. Currently included: man and bash_completion.
61
 
 
62
 
Examples: 
63
 
 
64
 
    python2.4 generated-docs.py --man
65
 
    python2.4 generated-docs.py --bash_completion
66
 
    python2.4 generated-docs.py --all
67
 
"""
 
61
import tools.doc_generate
68
62
 
69
63
def main(argv):
70
64
    from optparse import OptionParser
93
87
        sys.exit(1)
94
88
 
95
89
    infogen_type = args[1]
96
 
    infogen_mod = doc_generate.generate(infogen_type)
 
90
    infogen_mod = tools.doc_generate.get_module(infogen_type)
97
91
 
98
92
    if options.filename:
99
93
        outfilename = options.filename
111
105
    infogen_mod.infogen(options, outfile)
112
106
 
113
107
def print_extended_help(option, opt, value, parser):
114
 
    print >>sys.stdout, __doc__
115
 
    sys.exit(0)
116
 
 
 
108
        print >>sys.stdout, __doc__ % {"prog":sys.argv[0]}
 
109
        sys.exit(0)
117
110
 
118
111
if __name__ == '__main__':
119
112
    main(sys.argv)