nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-12-04 20:54:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
4f4a468e84
rust/mk/docs.mk

155 lines
4.0 KiB
Makefile
Raw Normal View History

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
######################################################################
# Pandoc (reference-manual related)
######################################################################
ifeq ($(CFG_PANDOC),)
$(info cfg: no pandoc found, omitting doc/rust.pdf)
else
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
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
ifeq ($(CFG_NODE),)
$(info cfg: no node found, omitting doc/tutorial.html)
else
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
[makefiles] Don't add css file to set of DOCS targets
2012-01-19 13:19:23 +00:00
DOCS += doc/rust.html
Tidy up doc make rules.
2012-03-27 00:59:09 +00:00
doc/rust.html: rust.md doc/version.md doc/keywords.md doc/rust.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 \
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=$@
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
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
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
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
DOCS += doc/rust.pdf
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
doc/rust.tex: rust.md doc/version.md doc/keywords.md
@$(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 \
--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
doc/rust.pdf: doc/rust.tex
@$(call E, pdflatex: $@)
$(Q)$(CFG_PDFLATEX) \
-interaction=batchmode \
-output-directory=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
endif
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
######################################################################
# Node (tutorial related)
######################################################################
ifeq ($(CFG_NODE),)
$(info cfg: no node found, omitting doc/tutorial.html)
else
DOCS += doc/tutorial.html
Tidy up doc make rules.
2012-03-27 00:59:09 +00:00
doc/tutorial.html: tutorial.md 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 \
--from=markdown --to=html --css=rust.css \
--output=$@
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
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
######################################################################
# 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: $@)
$(Q)$(S)src/etc/extract_grammar.py $< >$@
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
RUSTDOC = $(HBIN2_H_$(CFG_HOST_TRIPLE))/rustdoc$(X)
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/version.md: $(MKFILE_DEPS) rust.md
@$(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
Tidy up doc make rules.
2012-03-27 00:59:09 +00:00
doc/keywords.md: $(S)doc/keywords.txt $(MKFILE_DEPS) rust.md
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, grep -v: $$@)
$(Q)grep -v '^#' $< >$@
GENERATED += doc/keywords.md doc/version.md
Make clean cleaner.
2011-12-30 20:47:43 +00:00
docs: $(DOCS)
Reference in New Issue Copy Permalink