nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 14:55:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
bfd3cd8171
rust/mk/docs.mk

227 lines
6.8 KiB
Makefile
Raw Normal View History

Reliciense makefiles and testsuite. Yup.
2012-12-11 01:32:48 +00:00
# Copyright 2012 The Rust Project Developers. See the COPYRIGHT
# 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 20:18:52 +00: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 22:14:28 +00:00
DOCS :=
Start splitting up Makefile.in
2011-05-01 20:18:52 +00:00
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 22:14:28 +00: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 05:51:48 +00: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 22:14:28 +00: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-21 00:50:32 +00:00
Tidy up doc make rules.
2012-03-27 00:59:09 +00:00
doc/rust.css: rust.css
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
Display the full TOC in the manual. Closes #4194
2012-12-15 02:06:11 +00:00
doc/manual.css: manual.css
@$(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 05:51:48 +00: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 13:19:23 +00:00
DOCS += doc/rust.html
Display the full TOC in the manual. Closes #4194
2012-12-15 02:06:11 +00:00
doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.css
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00: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-21 00:50:32 +00:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
"$(CFG_PANDOC)" \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
--standalone --toc \
--section-divs \
--number-sections \
--from=markdown --to=html \
Add a stylesheet to make the reference HTML look a bit prettier
2012-01-18 08:58:08 +00:00
--css=rust.css \
Display the full TOC in the manual. Closes #4194
2012-12-15 02:06:11 +00:00
--css=manual.css \
doc: improvements to version-stamp makefile logic.
2013-02-06 22:59:03 +00:00
--include-before-body=doc/version_info.html \
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-21 00:50:32 +00:00
--output=$@
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
mk: Fix pdf build
2013-05-01 00:45:08 +00:00
DOCS += doc/rust.tex
doc: Remove unused keywords.txt
2012-04-20 03:06:13 +00: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-13 03:10:30 +00:00
@$(call E, pandoc: $@)
Prep docs before pdf.
2012-03-27 20:07:26 +00:00
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
"$(CFG_PANDOC)" \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
--standalone --toc \
--number-sections \
doc: improvements to version-stamp makefile logic.
2013-02-06 22:59:03 +00:00
--include-before-body=doc/version.md \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
--from=markdown --to=latex \
Prep docs before pdf.
2012-03-27 20:07:26 +00:00
--output=$@
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00:00
docs: Sketch out rustpkg manual
2013-04-18 23:15:17 +00:00
DOCS += doc/rustpkg.html
doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css doc/manual.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
"$(CFG_PANDOC)" \
--standalone --toc \
--section-divs \
--number-sections \
--from=markdown --to=html \
--css=rust.css \
--css=manual.css \
--include-before-body=doc/version_info.html \
--output=$@
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 11:51:20 +00:00
DOCS += doc/tutorial.html
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-17 23:15:37 +00:00
doc/tutorial.html: tutorial.md doc/version_info.html doc/rust.css
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 11:51:20 +00:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: Split macros out into a separate tutorial
2012-09-05 18:03:36 +00:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-macros.html
doc/tutorial-macros.html: tutorial-macros.md doc/version_info.html \
doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
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 18:20:04 +00:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-ffi.html
doc/tutorial-ffi.html: tutorial-ffi.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
docs: Add Niko's borrowed pointers tutorial
2012-09-16 00:09:21 +00:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-borrowed-ptr.html
doc/tutorial-borrowed-ptr.html: tutorial-borrowed-ptr.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: Split out task tutorail. Add links to sub-tutorials
2012-09-22 22:33:50 +00:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-tasks.html
doc/tutorial-tasks.html: tutorial-tasks.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 11:51:20 +00:00
--from=markdown --to=html --css=rust.css \
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-17 23:15:37 +00:00
--include-before-body=doc/version_info.html \
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 11:51:20 +00:00
--output=$@
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 05:51:48 +00: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-05-01 00:45:08 +00: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 05:51:48 +00:00
doc/rust.pdf: doc/rust.tex
@$(call E, pdflatex: $@)
$(Q)$(CFG_PDFLATEX) \
-interaction=batchmode \
-output-directory=doc \
$<
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 11:51:20 +00:00
endif
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 03:10:30 +00: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 05:51:48 +00: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 22:14:28 +00: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 07:53:05 +00: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 22:14:28 +00: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-18 00:49:57 +00: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 22:14:28 +00:00
######################################################################
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
# Rustdoc (libcore/std)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 22:14:28 +00:00
######################################################################
Start splitting up Makefile.in
2011-05-01 20:18:52 +00:00
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
ifeq ($(CFG_PANDOC),)
$(info cfg: no pandoc found, omitting library doc build)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 22:14:28 +00:00
else
Begin documenting std and add doc generation using naturaldocs Naturaldocs isn't really that great but it seems easier to get something working than with doxygen, for which we would need to convert rust code to something C++ish. We probably want to just write a rustdoc utility at some point.
2011-10-24 22:25:41 +00:00
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
# The rustdoc executable
mk: cleanup - lib and executable suffix handling
2013-03-02 12:25:12 +00:00
RUSTDOC = $(HBIN2_H_$(CFG_BUILD_TRIPLE))/rustdoc$(X_$(CFG_BUILD_TRIPLE))
Establish 'core' library separate from 'std'.
2011-12-06 00:46:37 +00:00
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
# The library documenting macro
# $(1) - The output directory
# $(2) - The crate file
# $(3) - The crate soruce files
define libdoc
doc/$(1)/index.html: $(2) $(3) $$(RUSTDOC) doc/$(1)/rust.css
@$$(call E, rustdoc: $$@)
$(Q)$(RUSTDOC) $(2) --output-dir=doc/$(1)
Establish 'core' library separate from 'std'.
2011-12-06 00:46:37 +00:00
Tidy up doc make rules.
2012-03-27 00:59:09 +00:00
doc/$(1)/rust.css: rust.css
Establish 'core' library separate from 'std'.
2011-12-06 00:46:37 +00:00
@$$(call E, cp: $$@)
$(Q)cp $$< $$@
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
DOCS += doc/$(1)/index.html
Establish 'core' library separate from 'std'.
2011-12-06 00:46:37 +00:00
endef
build: Switch from naturaldocs to rustdoc
2012-03-10 06:53:46 +00:00
$(eval $(call libdoc,core,$(CORELIB_CRATE),$(CORELIB_INPUTS)))
$(eval $(call libdoc,std,$(STDLIB_CRATE),$(STDLIB_INPUTS)))
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 22:14:28 +00:00
endif
ifdef CFG_DISABLE_DOCS
$(info cfg: disabling doc build (CFG_DISABLE_DOCS))
DOCS :=
endif
doc: improvements to version-stamp makefile logic.
2013-02-06 22:59:03 +00: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 22:14:28 +00:00
@$(call E, version-stamp: $@)
Tidy tidy
2012-01-18 22:45:47 +00: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 22:14:28 +00:00
doc: improvements to version-stamp makefile logic.
2013-02-06 22:59:03 +00: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 23:15:37 +00:00
@$(call E, version-info: $@)
sed -e "s/VERSION/$(CFG_RELEASE)/; s/SHORT_HASH/$(shell echo \
$(CFG_VER_HASH) | head -c 8)/;\
s/STAMP/$(CFG_VER_HASH)/;" $< >$@
doc: improvements to version-stamp makefile logic.
2013-02-06 22:59:03 +00:00
GENERATED += doc/version.md doc/version_info.html
Make clean cleaner.
2011-12-30 20:47:43 +00:00
docs: $(DOCS)
Reference in New Issue Copy Permalink