← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to Makefile

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-21 01:35:01 UTC
  • mfrom: (2733.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070821013501-op6nu6ae9u5gp56v
(Ian Clatworthy) Documentation organized into directories

Show diffs side-by-side

added added

removed removed

Lines of Context:
Makefile
17
17
# A relatively simple Makefile to assist in building parts of bzr. Mostly for
18
18
# building documentation, etc.
19
19
 
 
20
 
 
21
### Core Stuff ###
 
22
 
20
23
.PHONY: all clean extensions pyflakes api-docs
21
24
 
22
25
all: extensions
47
50
        -find . -name "*.pyc" -o -name "*.pyo" | xargs rm -f
48
51
        rm -rf test????.tmp
49
52
 
 
53
# Build API documentation
50
54
docfiles = bzr bzrlib
51
55
api-docs:
52
56
        mkdir -p api/html
53
57
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --html -o api/html --docformat 'restructuredtext en' $(docfiles)
54
 
 
55
58
check-api-docs:
56
59
        PYTHONPATH=$(PWD) python tools/bzr_epydoc --check --docformat 'restructuredtext en' $(docfiles)
57
60
 
58
 
 
59
61
# build emacs cross-reference
60
62
tag_files=./bzr ./bzrlib/*py ./bzrlib/selftest/*.py
61
63
TAGS: $(tag_files)
62
64
        ctags-exuberant -e $(tag_files)
63
65
 
64
66
 
65
 
# Produce HTML docs to upload on Canonical server
66
 
HTMLDIR := html_docs
67
 
PRETTYDIR := pretty_docs
68
 
 
69
 
html-docs: docs
70
 
        python tools/win32/ostools.py copytodir $(htm_files) doc/default.css $(HTMLDIR)
71
 
 
 
67
### Documentation ###
 
68
 
 
69
# set PRETTY to get docs that look like the Bazaar web site
 
70
ifdef PRETTY
 
71
rst2html := python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid 
 
72
else
 
73
rst2html := python tools/rst2html.py --link-stylesheet --footnote-references=superscript 
 
74
endif
72
75
 
73
76
# translate txt docs to html
74
 
doc_dir := doc 
75
 
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
 
77
derived_txt_files := \
 
78
        doc/en/user-reference/bzr_man.txt \
 
79
        doc/en/developer-guide/HACKING.txt \
 
80
        doc/en/release-notes/NEWS.txt
 
81
doc_dir := doc/en/user-guide
 
82
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) $(derived_txt_files) \
 
83
        doc/en/mini-tutorial/index.txt \
 
84
        doc/index.txt
 
85
non_txt_files := \
 
86
       doc/default.css \
 
87
       doc/en/quick-reference/quick-start-summary.svg
76
88
htm_files := $(patsubst %.txt, %.html, $(txt_files)) 
77
89
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
78
90
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files)) 
79
91
 
80
 
pretty-html-docs: pretty_files
81
 
 
82
 
pretty_docs:
83
 
        python -c "import os; os.mkdir('$(PRETTYDIR)')"
84
 
 
85
 
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.html, $(txt_files))
86
 
 
87
92
doc/developers/%.html: doc/developers/%.txt
88
 
        python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
 
93
        $(rst2html) --stylesheet=../default.css $< $@
 
94
 
 
95
doc/index.html: doc/index.txt
 
96
        $(rst2html) --stylesheet=default.css $< $@
89
97
 
90
98
%.html: %.txt
91
 
        python tools/rst2html.py --link-stylesheet --stylesheet=default.css --footnote-references=superscript $< $@
92
 
 
93
 
$(PRETTYDIR)/%.html: pretty_docs doc/%.txt
94
 
        python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
95
 
        $(PRETTYDIR)/$*.html
 
99
        $(rst2html) --stylesheet=../../default.css $< $@
96
100
 
97
101
MAN_DEPENDENCIES = bzrlib/builtins.py \
98
102
                 bzrlib/bundle/commands.py \
103
107
                 tools/doc_generate/autodoc_man.py \
104
108
                 tools/doc_generate/autodoc_rstx.py
105
109
 
106
 
doc/bzr_man.txt: $(MAN_DEPENDENCIES)
 
110
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
107
111
        python generate_docs.py -o $@ rstx
108
112
 
 
113
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
 
114
        python tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
 
115
 
 
116
doc/en/release-notes/NEWS.txt: NEWS
 
117
        python -c "import shutil; shutil.copyfile('$<', '$@')"
 
118
 
109
119
MAN_PAGES = man1/bzr.1
110
120
man1/bzr.1: $(MAN_DEPENDENCIES)
111
121
        python generate_docs.py -o $@ man
112
122
 
113
 
ALL_DOCS = $(htm_files) $(MAN_PAGES) $(dev_htm_files) doc/developers/performance.png
 
123
# build a png of our performance task list
 
124
doc/developers/performance.png: doc/developers/performance.dot
 
125
        @echo Generating $@
 
126
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
 
127
 
 
128
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
 
129
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
 
130
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
 
131
 
 
132
# the main target to build all the docs
114
133
docs: $(ALL_DOCS)
115
134
 
116
 
copy-docs: docs
117
 
        python tools/win32/ostools.py copytodir $(htm_files) \
118
 
                doc/default.css NEWS README \
119
 
                win32_bzr.exe/doc
120
 
        python tools/win32/ostools.py copytodir $(dev_htm_files) \
121
 
                win32_bzr.exe/doc/developers
 
135
# produce a tree containing just the final docs, ready for uploading to the web
 
136
HTMLDIR := html_docs
 
137
html-docs: docs
 
138
        python tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
122
139
 
123
140
# clean produced docs
124
141
clean-docs:
125
142
        python tools/win32/ostools.py remove $(ALL_DOCS) \
126
 
        $(HTMLDIR) $(PRETTYDIR) doc/bzr_man.txt
127
 
 
128
 
 
129
 
# build a png of our performance task list
130
 
doc/developers/performance.png: doc/developers/performance.dot
131
 
        @echo Generating $@
132
 
        @dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
133
 
 
 
143
        $(HTMLDIR) $(derived_txt_files)
 
144
 
 
145
 
 
146
### Windows Support ###
134
147
 
135
148
# make bzr.exe for win32 with py2exe
136
149
exe:
152
165
        python24 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
153
166
        python25 setup.py bdist_wininst --install-script="bzr-win32-bdist-postinstall.py" -d .
154
167
 
 
168
copy-docs: docs
 
169
        python tools/win32/ostools.py copytodir README win32_bzr.exe/doc
 
170
        python tools/win32/ostools.py copytree $(WEB_DOCS) win32_bzr.exe
155
171
 
156
172
# clean on win32 all installer-related files and directories
157
173
clean-win32: clean-docs
158
174
        python tools/win32/ostools.py remove build
159
175
        python tools/win32/ostools.py remove win32_bzr.exe
160
176
        python tools/win32/ostools.py remove py2exe.log
161
 
        python tools/win32/ostools.py remove doc/bzr_man.txt
162
177
        python tools/win32/ostools.py remove tools/win32/bzr.iss
163
178
        python tools/win32/ostools.py remove bzr-setup*.exe
164
179
        python tools/win32/ostools.py remove bzr-*win32.exe