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