mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1dcc986d52
rust/mk/docs.mk

285 lines
8.7 KiB
Makefile
Raw Normal View History

doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
# Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
Reliciense makefiles and testsuite. Yup.
2012-12-10 19:32:48 -06:00
# file at the top-level directory of this distribution and at
# http://rust-lang.org/COPYRIGHT.
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
# option. This file may not be copied, modified, or distributed
# except according to those terms.
Start splitting up Makefile.in
2011-05-01 15:18:52 -05:00
######################################################################
# Doc variables and rules
######################################################################
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
DOCS :=
Add a compiler-docs target
2013-12-28 23:13:19 -06:00
CDOCS :=
tutorial: Add Japanese translation
2013-08-08 08:38:33 -05:00
DOCS_L10N :=
Start splitting up Makefile.in
2011-05-01 15:18:52 -05:00
doc: CSS changes + commit improved favicon
2013-12-07 10:42:00 -06:00
BASE_DOC_OPTS := --from=markdown --standalone --toc --number-sections
HTML_OPTS = $(BASE_DOC_OPTS) --to=html5 --section-divs --css=rust.css --include-before-body=doc/version_info.html --include-in-header=doc/favicon.inc
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
TEX_OPTS = $(BASE_DOC_OPTS) --to=latex
EPUB_OPTS = $(BASE_DOC_OPTS) --to=epub
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 21:10:30 -06:00
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
######################################################################
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
# Docs, from pandoc, rustdoc (which runs pandoc), and node
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
######################################################################
doc: Run language ref through prep.js This is so we can strip out support code needed to make the examples work, and as a bonus it does syntax highlighting.
2012-03-20 19:50:32 -05:00
Tidy up doc make rules.
2012-03-26 19:59:09 -05:00
doc/rust.css: rust.css
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
doc/manual.inc: manual.inc
Display the full TOC in the manual. Closes #4194
2012-12-14 20:06:11 -06:00
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/favicon.inc: favicon.inc
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
ifeq ($(CFG_PANDOC),)
$(info cfg: no pandoc found, omitting docs)
NO_DOCS = 1
endif
ifeq ($(CFG_NODE),)
$(info cfg: no node found, omitting docs)
NO_DOCS = 1
endif
ifneq ($(NO_DOCS),1)
[makefiles] Don't add css file to set of DOCS targets
2012-01-19 07:19:23 -06:00
DOCS += doc/rust.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.inc \
doc/favicon.inc
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 21:10:30 -06:00
@$(call E, pandoc: $@)
doc: Run language ref through prep.js This is so we can strip out support code needed to make the examples work, and as a bonus it does syntax highlighting.
2012-03-20 19:50:32 -05:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --include-in-header=doc/manual.inc --output=$@
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 21:10:30 -06:00
mk: Fix pdf build
2013-04-30 19:45:08 -05:00
DOCS += doc/rust.tex
doc: Remove unused keywords.txt
2012-04-19 22:06:13 -05:00
doc/rust.tex: rust.md doc/version.md
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 21:10:30 -06:00
@$(call E, pandoc: $@)
Prep docs before pdf.
2012-03-27 15:07:26 -05:00
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(TEX_OPTS) --output=$@
doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
Create epub versions of tutorial and ref manual. Pandoc can create epub verions of the markdown files. Since the docs are lengthy, epubs are handy to have around. Two rules to create epub versions of the reference manual and the main tutorial are added here. Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>
2013-11-01 14:13:00 -05:00
DOCS += doc/rust.epub
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
doc/rust.epub: rust.md doc/version_info.html doc/rust.css
Create epub versions of tutorial and ref manual. Pandoc can create epub verions of the markdown files. Since the docs are lengthy, epubs are handy to have around. Two rules to create epub versions of the reference manual and the main tutorial are added here. Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>
2013-11-01 14:13:00 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(EPUB_OPTS) --output=$@
Create epub versions of tutorial and ref manual. Pandoc can create epub verions of the markdown files. Since the docs are lengthy, epubs are handy to have around. Two rules to create epub versions of the reference manual and the main tutorial are added here. Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>
2013-11-01 14:13:00 -05:00
docs: Sketch out rustpkg manual
2013-04-18 18:15:17 -05:00
DOCS += doc/rustpkg.html
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css \
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/favicon.inc
docs: Sketch out rustpkg manual
2013-04-18 18:15:17 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
docs: Sketch out rustpkg manual
2013-04-18 18:15:17 -05:00
Add rustdoc documentation.
2013-12-06 10:29:58 -06:00
DOCS += doc/rustdoc.html
doc/rustdoc.html: rustdoc.md doc/version_info.html doc/rust.css \
doc/favicon.inc
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 05:51:20 -06:00
DOCS += doc/tutorial.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial.html: tutorial.md doc/version_info.html doc/rust.css \
doc/favicon.inc
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 05:51:20 -06:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
doc: Split macros out into a separate tutorial
2012-09-05 13:03:36 -05:00
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
DOCS += doc/tutorial.tex
doc/tutorial.tex: tutorial.md doc/version.md
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(TEX_OPTS) --output=$@
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
Create epub versions of tutorial and ref manual. Pandoc can create epub verions of the markdown files. Since the docs are lengthy, epubs are handy to have around. Two rules to create epub versions of the reference manual and the main tutorial are added here. Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>
2013-11-01 14:13:00 -05:00
DOCS += doc/tutorial.epub
doc/tutorial.epub: tutorial.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(EPUB_OPTS) --output=$@
Create epub versions of tutorial and ref manual. Pandoc can create epub verions of the markdown files. Since the docs are lengthy, epubs are handy to have around. Two rules to create epub versions of the reference manual and the main tutorial are added here. Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>
2013-11-01 14:13:00 -05:00
tutorial: Add Japanese translation
2013-08-08 08:38:33 -05:00
DOCS_L10N += doc/l10n/ja/tutorial.html
doc/l10n/ja/tutorial.html: doc/l10n/ja/tutorial.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight doc/l10n/ja/tutorial.md | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: switch pandoc to html5
2013-10-11 12:18:43 -05:00
--from=markdown --to=html5 --css=../../rust.css \
doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
--include-before-body=doc/version_info.html \
tutorial: Add Japanese translation
2013-08-08 08:38:33 -05:00
--output=$@
doc: Split macros out into a separate tutorial
2012-09-05 13:03:36 -05:00
DOCS += doc/tutorial-macros.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-macros.html: tutorial-macros.md doc/version_info.html doc/rust.css \
doc/favicon.inc
doc: Split macros out into a separate tutorial
2012-09-05 13:03:36 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
doc: Split out the FFI part of the tutorial The tutorial should perhaps contain an FFI section, but this one is too long.
2012-09-05 13:20:04 -05:00
add a tutorial on containers and iterators
2013-06-27 17:48:12 -05:00
DOCS += doc/tutorial-container.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-container.html: tutorial-container.md doc/version_info.html doc/rust.css \
doc/favicon.inc
add a tutorial on containers and iterators
2013-06-27 17:48:12 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
add a tutorial on containers and iterators
2013-06-27 17:48:12 -05:00
doc: Split out the FFI part of the tutorial The tutorial should perhaps contain an FFI section, but this one is too long.
2012-09-05 13:20:04 -05:00
DOCS += doc/tutorial-ffi.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-ffi.html: tutorial-ffi.md doc/version_info.html doc/rust.css \
doc/favicon.inc
doc: Split out the FFI part of the tutorial The tutorial should perhaps contain an FFI section, but this one is too long.
2012-09-05 13:20:04 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
docs: Add Niko's borrowed pointers tutorial
2012-09-15 19:09:21 -05:00
DOCS += doc/tutorial-borrowed-ptr.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-borrowed-ptr.html: tutorial-borrowed-ptr.md doc/version_info.html doc/rust.css \
doc/favicon.inc
docs: Add Niko's borrowed pointers tutorial
2012-09-15 19:09:21 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
doc: Split out task tutorail. Add links to sub-tutorials
2012-09-22 17:33:50 -05:00
DOCS += doc/tutorial-tasks.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-tasks.html: tutorial-tasks.md doc/version_info.html doc/rust.css \
doc/favicon.inc
doc: Split out task tutorail. Add links to sub-tutorials
2012-09-22 17:33:50 -05:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 05:51:20 -06:00
doc: add condition tutorial
2013-08-16 18:03:24 -05:00
DOCS += doc/tutorial-conditions.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-conditions.html: tutorial-conditions.md doc/version_info.html doc/rust.css \
doc/favicon.inc
doc: add condition tutorial
2013-08-16 18:03:24 -05:00
@$(call E, pandoc: $@)
Add rustpkg tutorial to the official tutorials. Three things in this commit: 1. Actually build the rustpkg tutorial. I didn't know I needed this when I first wrote it. 2. Link to it rather than the manual from the tutorial. 3. Update the headers: most of them were one level too deeply nested.
2013-09-23 16:36:38 -05:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
Add rustpkg tutorial to the official tutorials. Three things in this commit: 1. Actually build the rustpkg tutorial. I didn't know I needed this when I first wrote it. 2. Link to it rather than the manual from the tutorial. 3. Update the headers: most of them were one level too deeply nested.
2013-09-23 16:36:38 -05:00
DOCS += doc/tutorial-rustpkg.html
doc: add favicon to tutorial/manual Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
2013-11-11 09:13:56 -06:00
doc/tutorial-rustpkg.html: tutorial-rustpkg.md doc/version_info.html doc/rust.css \
doc/favicon.inc
Add rustpkg tutorial to the official tutorials. Three things in this commit: 1. Actually build the rustpkg tutorial. I didn't know I needed this when I first wrote it. 2. Link to it rather than the manual from the tutorial. 3. Update the headers: most of them were one level too deeply nested.
2013-09-23 16:36:38 -05:00
@$(call E, pandoc: $@)
doc: add condition tutorial
2013-08-16 18:03:24 -05:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
doc: tidy up makefile rules
2013-11-11 15:17:54 -06:00
$(CFG_PANDOC) $(HTML_OPTS) --output=$@
doc: add condition tutorial
2013-08-16 18:03:24 -05:00
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
ifeq ($(CFG_PDFLATEX),)
$(info cfg: no pdflatex found, omitting doc/rust.pdf)
else
ifeq ($(CFG_XETEX),)
$(info cfg: no xetex found, disabling doc/rust.pdf)
else
ifeq ($(CFG_LUATEX),)
$(info cfg: lacking luatex, disabling pdflatex)
else
mk: Fix pdf build
2013-04-30 19:45:08 -05:00
DOCS += doc/rust.pdf
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
doc/rust.pdf: doc/rust.tex
@$(call E, pdflatex: $@)
$(Q)$(CFG_PDFLATEX) \
-interaction=batchmode \
-output-directory=doc \
$<
doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
DOCS += doc/tutorial.pdf
doc/tutorial.pdf: doc/tutorial.tex
@$(call E, pdflatex: $@)
$(Q)$(CFG_PDFLATEX) \
-interaction=batchmode \
-output-directory=doc \
$<
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
endif
endif
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 05:51:20 -06:00
endif
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 21:10:30 -06:00
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 00:51:48 -05:00
endif # No pandoc / node
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
######################################################################
# LLnextgen (grammar analysis from refman)
######################################################################
ifeq ($(CFG_LLNEXTGEN),)
$(info cfg: no llnextgen found, omitting grammar-verification)
else
.PHONY: verify-grammar
doc/rust.g: rust.md $(S)src/etc/extract_grammar.py
@$(call E, extract_grammar: $@)
add missing $(CFG_PYTHON) prefixes
2013-01-03 01:53:05 -06:00
$(Q)$(CFG_PYTHON) $(S)src/etc/extract_grammar.py $< >$@
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
verify-grammar: doc/rust.g
@$(call E, LLnextgen: $<)
$(Q)$(CFG_LLNEXTGEN) --generate-lexer-wrapper=no $< >$@
$(Q)rm -f doc/rust.c doc/rust.h
Move the ifdefs to nest properly. Real clever.
2012-01-17 18:49:57 -06:00
endif
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
######################################################################
libstd: Rename libcore to libstd and libstd to libextra; update makefiles. This only changes the directory names; it does not change the "real" metadata names.
2013-05-17 12:45:09 -05:00
# Rustdoc (libstd/extra)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
######################################################################
Start splitting up Makefile.in
2011-05-01 15:18:52 -05:00
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
# The rustdoc executable
support for GNU configure syntax
2013-10-21 04:18:21 -05:00
RUSTDOC = $(HBIN2_H_$(CFG_BUILD))/rustdoc$(X_$(CFG_BUILD))
Establish 'core' library separate from 'std'.
2011-12-05 18:46:37 -06:00
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
# The library documenting macro
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 01:25:48 -05:00
# $(1) - The crate name (std/extra)
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
# $(2) - The crate file
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 01:25:48 -05:00
# $(3) - The relevant host build triple (to depend on libstd)
rustdoc: pass through --cfg to rustc Closes #10623
2013-11-24 22:31:21 -06:00
#
# Passes --cfg stage2 to rustdoc because it uses the stage2 librustc.
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
define libdoc
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 01:25:48 -05:00
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
@$$(call E, rustdoc: $$@)
rustdoc: pass through --cfg to rustc Closes #10623
2013-11-24 22:31:21 -06:00
$(Q)$(RUSTDOC) --cfg stage2 $(2)
Establish 'core' library separate from 'std'.
2011-12-05 18:46:37 -06:00
build: Switch from naturaldocs to rustdoc
2012-03-10 00:53:46 -06:00
DOCS += doc/$(1)/index.html
Establish 'core' library separate from 'std'.
2011-12-05 18:46:37 -06:00
endef
Add a compiler-docs target
2013-12-28 23:13:19 -06:00
define compiledoc
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
@$$(call E, rustdoc: $$@)
$(Q)$(RUSTDOC) --cfg stage2 $(2)
CDOCS += doc/$(1)/index.html
endef
support for GNU configure syntax
2013-10-21 04:18:21 -05:00
$(eval $(call libdoc,std,$(STDLIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD)))
Add docs for more crates
2013-12-28 12:06:05 -06:00
$(eval $(call libdoc,native,$(LIBNATIVE_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,green,$(LIBGREEN_CRATE),$(CFG_BUILD)))
Add a compiler-docs target
2013-12-28 23:13:19 -06:00
$(eval $(call compiledoc,rustc,$(COMPILER_CRATE),$(CFG_BUILD)))
$(eval $(call compiledoc,syntax,$(LIBSYNTAX_CRATE),$(CFG_BUILD)))
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
ifdef CFG_DISABLE_DOCS
$(info cfg: disabling doc build (CFG_DISABLE_DOCS))
DOCS :=
endif
doc: improvements to version-stamp makefile logic.
2013-02-06 16:59:03 -06:00
doc/version.md: $(MKFILE_DEPS) $(wildcard $(S)doc/*.*)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
@$(call E, version-stamp: $@)
Tidy tidy
2012-01-18 16:45:47 -06:00
$(Q)echo "$(CFG_VERSION)" >$@
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 16:14:28 -06:00
doc: improvements to version-stamp makefile logic.
2013-02-06 16:59:03 -06:00
doc/version_info.html: version_info.html.template $(MKFILE_DEPS) \
$(wildcard $(S)doc/*.*)
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-17 18:15:37 -05:00
@$(call E, version-info: $@)
sed -e "s/VERSION/$(CFG_RELEASE)/; s/SHORT_HASH/$(shell echo \
$(CFG_VER_HASH) | head -c 8)/;\
doc: tidy and cleanup CSS deps, add tutorial PDF generation
2013-10-11 13:21:46 -05:00
s/STAMP/$(CFG_VER_HASH)/;" $< >$@
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-17 18:15:37 -05:00
doc: improvements to version-stamp makefile logic.
2013-02-06 16:59:03 -06:00
GENERATED += doc/version.md doc/version_info.html
Make clean cleaner.
2011-12-30 14:47:43 -06:00
docs: $(DOCS)
Add a compiler-docs target
2013-12-28 23:13:19 -06:00
compiler-docs: $(CDOCS)
Use po4a to provide translatable documentation This commit add a new "docs-l10n" make target which uses po4a to: * create .pot (PO templates) from markdown doc * update templates and po for enabled languages * generate translated markdown for completed (> 80%) translations Currently, no language has been activated. Signed-off-by: Luca Bruno <lucab@debian.org>
2013-07-07 14:12:00 -05:00
tutorial: Add Japanese translation
2013-08-08 08:38:33 -05:00
docs-l10n: $(DOCS_L10N)
doc/l10n/%.md: doc/po/%.md.po doc/po4a.conf
Add project information to l10n templates.
2013-07-16 17:18:42 -05:00
po4a --copyright-holder="The Rust Project Developers" \
--package-name="Rust" \
--package-version="$(CFG_RELEASE)" \
doc: Add -M and -L option to po4a
2013-07-29 17:05:47 -05:00
-M UTF-8 -L UTF-8 \
Add project information to l10n templates.
2013-07-16 17:18:42 -05:00
doc/po4a.conf
Use po4a to provide translatable documentation This commit add a new "docs-l10n" make target which uses po4a to: * create .pot (PO templates) from markdown doc * update templates and po for enabled languages * generate translated markdown for completed (> 80%) translations Currently, no language has been activated. Signed-off-by: Luca Bruno <lucab@debian.org>
2013-07-07 14:12:00 -05:00
.PHONY: docs-l10n
Reference in New Issue Copy Permalink