mk/docs.mk

   1 # Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 # file at the top-level directory of this distribution and at
   3 # http://rust-lang.org/COPYRIGHT.
   4 #
   5 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 # http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 # <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 # option. This file may not be copied, modified, or distributed
   9 # except according to those terms.
  10
  11 ######################################################################
  12 # The various pieces of standalone documentation: guides, tutorial,
  13 # manual etc.
  14 #
  15 # The DOCS variable is their names (with no file extension).
  16 #
  17 # PDF_DOCS lists the targets for which PDF documentation should be
  18 # build.
  19 #
  20 # RUSTDOC_FLAGS_xyz variables are extra arguments to pass to the
  21 # rustdoc invocation for xyz.
  22 #
  23 # RUSTDOC_DEPS_xyz are extra dependencies for the rustdoc invocation
  24 # on xyz.
  25 #
  26 # L10N_LANGS are the languages for which the docs have been
  27 # translated.
  28 ######################################################################
  29 DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
  30         guide-tasks guide-container guide-pointers guide-testing \
  31         guide-runtime complement-bugreport \
  32         complement-lang-faq complement-design-faq complement-project-faq rust \
  33     rustdoc guide-unsafe
  34
  35 PDF_DOCS := tutorial rust
  36
  37 RUSTDOC_DEPS_rust := doc/full-toc.inc
  38 RUSTDOC_FLAGS_rust := --markdown-in-header=doc/full-toc.inc
  39
  40 L10N_LANGS := ja
  41
  42 # Generally no need to edit below here.
  43
  44 # The options are passed to the documentation generators.
  45 RUSTDOC_HTML_OPTS_NO_CSS = --markdown-before-content=doc/version_info.html \
  46         --markdown-in-header=doc/favicon.inc \
  47         --markdown-after-content=doc/footer.inc \
  48         --markdown-playground-url='http://play.rust-lang.org/'
  49
  50 RUSTDOC_HTML_OPTS = $(RUSTDOC_HTML_OPTS_NO_CSS) --markdown-css rust.css
  51
  52 PANDOC_BASE_OPTS := --standalone --toc --number-sections
  53 PANDOC_TEX_OPTS = $(PANDOC_BASE_OPTS) --include-before-body=doc/version.tex \
  54         --from=markdown --include-before-body=doc/footer.tex --to=latex
  55 PANDOC_EPUB_OPTS = $(PANDOC_BASE_OPTS) --to=epub
  56
  57 # The rustdoc executable...
  58 RUSTDOC_EXE = $(HBIN2_H_$(CFG_BUILD))/rustdoc$(X_$(CFG_BUILD))
  59 # ...with rpath included in case --disable-rpath was provided to
  60 # ./configure
  61 RUSTDOC = $(RPATH_VAR2_T_$(CFG_BUILD)_H_$(CFG_BUILD)) $(RUSTDOC_EXE)
  62
  63 D := $(S)src/doc
  64
  65 DOC_TARGETS :=
  66 COMPILER_DOC_TARGETS :=
  67 DOC_L10N_TARGETS :=
  68
  69 # If NO_REBUILD is set then break the dependencies on rustdoc so we
  70 # build the documentation without having to rebuild rustdoc.
  71 ifeq ($(NO_REBUILD),)
  72 HTML_DEPS := $(RUSTDOC_EXE)
  73 else
  74 HTML_DEPS :=
  75 endif
  76
  77 # Check for the various external utilities for the EPUB/PDF docs:
  78
  79 ifeq ($(CFG_PDFLATEX),)
  80   $(info cfg: no pdflatex found, deferring to xelatex)
  81   ifeq ($(CFG_XELATEX),)
  82     $(info cfg: no xelatex found, deferring to lualatex)
  83     ifeq ($(CFG_LUALATEX),)
  84       $(info cfg: no lualatex found, disabling LaTeX docs)
  85       NO_PDF_DOCS = 1
  86         else
  87       CFG_LATEX := $(CFG_LUALATEX)
  88     endif
  89   else
  90     CFG_LATEX := $(CFG_XELATEX)
  91   endif
  92 else
  93   CFG_LATEX := $(CFG_PDFLATEX)
  94 endif
  95
  96
  97 ifeq ($(CFG_PANDOC),)
  98 $(info cfg: no pandoc found, omitting PDF and EPUB docs)
  99 ONLY_HTML_DOCS = 1
 100 endif
 101
 102
 103 ######################################################################
 104 # Rust version
 105 ######################################################################
 106
 107 doc/version.tex: $(MKFILE_DEPS) $(wildcard $(D)/*.*) | doc/
 108         @$(call E, version-stamp: $@)
 109         $(Q)echo "$(CFG_VERSION)" >$@
 110
 111 HTML_DEPS += doc/version_info.html
 112 doc/version_info.html: $(D)/version_info.html.template $(MKFILE_DEPS) \
 113                        $(wildcard $(D)/*.*) | doc/
 114         @$(call E, version-info: $@)
 115         $(Q)sed -e "s/VERSION/$(CFG_RELEASE)/; s/SHORT_HASH/$(shell echo \
 116                     $(CFG_VER_HASH) | head -c 8)/;\
 117                 s/STAMP/$(CFG_VER_HASH)/;" $< >$@
 118
 119 GENERATED += doc/version.tex doc/version_info.html
 120
 121 ######################################################################
 122 # Docs, from rustdoc and sometimes pandoc
 123 ######################################################################
 124
 125 doc/:
 126         @mkdir -p $@
 127
 128 HTML_DEPS += doc/rust.css
 129 doc/rust.css: $(D)/rust.css | doc/
 130         @$(call E, cp: $@)
 131         $(Q)cp -a $< $@ 2> /dev/null
 132
 133 HTML_DEPS += doc/favicon.inc
 134 doc/favicon.inc: $(D)/favicon.inc | doc/
 135         @$(call E, cp: $@)
 136         $(Q)cp -a $< $@ 2> /dev/null
 137
 138 doc/full-toc.inc: $(D)/full-toc.inc | doc/
 139         @$(call E, cp: $@)
 140         $(Q)cp -a $< $@ 2> /dev/null
 141
 142 HTML_DEPS += doc/footer.inc
 143 doc/footer.inc: $(D)/footer.inc | doc/
 144         @$(call E, cp: $@)
 145         $(Q)cp -a $< $@ 2> /dev/null
 146
 147 # The (english) documentation for each doc item.
 148
 149 define DEF_SHOULD_BUILD_PDF_DOC
 150 SHOULD_BUILD_PDF_DOC_$(1) = 1
 151 endef
 152 $(foreach docname,$(PDF_DOCS),$(eval $(call DEF_SHOULD_BUILD_PDF_DOC,$(docname))))
 153
 154 doc/footer.tex: $(D)/footer.inc | doc/
 155         @$(call E, pandoc: $@)
 156         $(CFG_PANDOC) --from=html --to=latex $< --output=$@
 157
 158 # HTML (rustdoc)
 159 DOC_TARGETS += doc/not_found.html
 160 doc/not_found.html: $(D)/not_found.md $(HTML_DEPS) | doc/
 161         @$(call E, rustdoc: $@)
 162         $(Q)$(RUSTDOC) $(RUSTDOC_HTML_OPTS_NO_CSS) \
 163                 --markdown-css http://doc.rust-lang.org/rust.css $<
 164
 165 define DEF_DOC
 166
 167 # HTML (rustdoc)
 168 DOC_TARGETS += doc/$(1).html
 169 doc/$(1).html: $$(D)/$(1).md $$(HTML_DEPS) $$(RUSTDOC_DEPS_$(1)) | doc/
 170         @$$(call E, rustdoc: $$@)
 171         $$(Q)$$(RUSTDOC) $$(RUSTDOC_HTML_OPTS) $$(RUSTDOC_FLAGS_$(1)) $$<
 172
 173 ifneq ($(ONLY_HTML_DOCS),1)
 174
 175 # EPUB (pandoc directly)
 176 DOC_TARGETS += doc/$(1).epub
 177 doc/$(1).epub: $$(D)/$(1).md | doc/
 178         @$$(call E, pandoc: $$@)
 179         $$(CFG_PANDOC) $$(PANDOC_EPUB_OPTS) $$< --output=$$@
 180
 181 # PDF (md =(pandoc)=> tex =(pdflatex)=> pdf)
 182 DOC_TARGETS += doc/$(1).tex
 183 doc/$(1).tex: $$(D)/$(1).md doc/footer.tex doc/version.tex | doc/
 184         @$$(call E, pandoc: $$@)
 185         $$(CFG_PANDOC) $$(PANDOC_TEX_OPTS) $$< --output=$$@
 186
 187 ifneq ($(NO_PDF_DOCS),1)
 188 ifeq ($$(SHOULD_BUILD_PDF_DOC_$(1)),1)
 189 DOC_TARGETS += doc/$(1).pdf
 190 doc/$(1).pdf: doc/$(1).tex
 191         @$$(call E, latex compiler: $$@)
 192         $$(Q)$$(CFG_LATEX) \
 193         -interaction=batchmode \
 194         -output-directory=doc \
 195         $$<
 196 endif # SHOULD_BUILD_PDF_DOCS_$(1)
 197 endif # NO_PDF_DOCS
 198
 199 endif # ONLY_HTML_DOCS
 200
 201 endef
 202
 203 $(foreach docname,$(DOCS),$(eval $(call DEF_DOC,$(docname))))
 204
 205
 206 # Localized documentation
 207
 208 # FIXME: I (huonw) haven't actually been able to test properly, since
 209 # e.g. (by default) I'm doing an out-of-tree build (#12763), but even
 210 # adjusting for that, the files are too old(?) and are rejected by
 211 # po4a.
 212 #
 213 # As such, I've attempted to get it working as much as possible (and
 214 # switching from pandoc to rustdoc), but preserving the old behaviour
 215 # (e.g. only running on the tutorial)
 216 .PHONY: l10n-mds
 217 l10n-mds: $(D)/po4a.conf \
 218                 $(foreach lang,$(L10N_LANG),$(D)/po/$(lang)/*.md.po)
 219         $(warning WARNING: localized documentation is experimental)
 220         po4a --copyright-holder="The Rust Project Developers" \
 221                 --package-name="Rust" \
 222                 --package-version="$(CFG_RELEASE)" \
 223                 -M UTF-8 -L UTF-8 \
 224                 $(D)/po4a.conf
 225
 226 define DEF_L10N_DOC
 227 DOC_L10N_TARGETS += doc/l10n/$(1)/$(2).html
 228 doc/l10n/$(1)/$(2).html: l10n-mds $$(HTML_DEPS) $$(RUSTDOC_DEPS_$(2))
 229         @$$(call E, rustdoc: $$@)
 230         $$(RUSTDOC) $$(RUSTDOC_HTML_OPTS) $$(RUSTDOC_FLAGS_$(1)) doc/l10n/$(1)/$(2).md
 231 endef
 232
 233 $(foreach lang,$(L10N_LANGS),$(eval $(call DEF_L10N_DOC,$(lang),tutorial)))
 234
 235
 236 ######################################################################
 237 # LLnextgen (grammar analysis from refman)
 238 ######################################################################
 239
 240 ifeq ($(CFG_LLNEXTGEN),)
 241   $(info cfg: no llnextgen found, omitting grammar-verification)
 242 else
 243 .PHONY: verify-grammar
 244
 245 doc/rust.g: $(D)/rust.md $(S)src/etc/extract_grammar.py
 246         @$(call E, extract_grammar: $@)
 247         $(Q)$(CFG_PYTHON) $(S)src/etc/extract_grammar.py $< >$@
 248
 249 verify-grammar: doc/rust.g
 250         @$(call E, LLnextgen: $<)
 251         $(Q)$(CFG_LLNEXTGEN) --generate-lexer-wrapper=no $< >$@
 252         $(Q)rm -f doc/rust.c doc/rust.h
 253 endif
 254
 255
 256 ######################################################################
 257 # Rustdoc (libstd/extra)
 258 ######################################################################
 259
 260
 261 # The library documenting macro
 262 #
 263 # $(1) - The crate name (std/extra)
 264 #
 265 # Passes --cfg stage2 to rustdoc because it uses the stage2 librustc.
 266 define DEF_LIB_DOC
 267
 268 # If NO_REBUILD is set then break the dependencies on rustdoc so we
 269 # build crate documentation without having to rebuild rustdoc.
 270 ifeq ($(NO_REBUILD),)
 271 LIB_DOC_DEP_$(1) = \
 272         $$(CRATEFILE_$(1)) \
 273         $$(RSINPUTS_$(1)) \
 274         $$(RUSTDOC_EXE) \
 275         $$(foreach dep,$$(RUST_DEPS_$(1)), \
 276                 $$(TLIB2_T_$(CFG_BUILD)_H_$(CFG_BUILD))/stamp.$$(dep) \
 277                 doc/$$(dep)/)
 278 else
 279 LIB_DOC_DEP_$(1) = $$(CRATEFILE_$(1)) $$(RSINPUTS_$(1))
 280 endif
 281
 282 doc/$(1)/:
 283         $$(Q)mkdir -p $$@
 284
 285 $(2) += doc/$(1)/index.html
 286 doc/$(1)/index.html: CFG_COMPILER_HOST_TRIPLE = $(CFG_TARGET)
 287 doc/$(1)/index.html: $$(LIB_DOC_DEP_$(1)) doc/$(1)/
 288         @$$(call E, rustdoc $$@)
 289         $$(Q)$$(RUSTDOC) --cfg dox --cfg stage2 $$<
 290 endef
 291
 292 $(foreach crate,$(DOC_CRATES),$(eval $(call DEF_LIB_DOC,$(crate),DOC_TARGETS)))
 293 $(foreach crate,$(COMPILER_DOC_CRATES),$(eval $(call DEF_LIB_DOC,$(crate),COMPILER_DOC_TARGETS)))
 294
 295 ifdef CFG_DISABLE_DOCS
 296   $(info cfg: disabling doc build (CFG_DISABLE_DOCS))
 297   DOC_TARGETS :=
 298   COMPILER_DOC_TARGETS :=
 299 endif
 300
 301 docs: $(DOC_TARGETS)
 302 compiler-docs: $(COMPILER_DOC_TARGETS)
 303
 304 docs-l10n: $(DOC_L10N_TARGETS)
 305
 306 .PHONY: docs-l10n