Commit Graph

65 Commits

Author SHA1 Message Date
Noufal Ibrahim
759c0168a1 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-03 18:39:36 +05:30
Heather
8a593a8bdb support for GNU configure syntax 2013-10-29 16:22:08 -07:00
Adrien Tétar
8d97db48d4 doc: tidy and cleanup CSS deps, add tutorial PDF generation 2013-10-21 04:12:12 +02:00
Adrien Tétar
f69795e443 doc: switch pandoc to html5 2013-10-19 20:29:34 +02:00
Alex Crichton
e523f99fb9 rustdoc: Add the ability to input json
This modifies the command-line usage of rustdoc to intake its own JSON output as
well as a rust source file. This also alters the command line from
`rustdoc input file`  to `rustdoc file` with the input/output formats specified
as -r and -w, respectively.

When using a JSON input, no passes or plugins are re-run over the json, instead
the output is generated directly from the JSON that was provided. Passes and
plugins are still run on rust source input, however.
2013-09-30 20:31:19 -07:00
Alex Crichton
8973d7c3f5 mk: Don't require pandoc to run rustdoc 2013-09-27 16:54:45 -07:00
Steve Klabnik
06b11ba172 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 14:36:38 -07:00
Alex Crichton
7b24efd6f3 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 09:51:15 -07:00
Alex Crichton
02b27b2998 Fix the dependencies of rustdoc_ng doc generation
This needs libstd in its proper location to resolve references when generating
docs for libextra.
2013-09-21 13:25:33 -07:00
Alex Crichton
4fd061c426 Implement a web backend for rustdoc_ng
This large commit implements and `html` output option for rustdoc_ng. The
executable has been altered to be invoked as "rustdoc_ng html <crate>" and
it will dump everything into the local "doc" directory. JSON can still be
generated by changing 'html' to 'json'.

This also fixes a number of bugs in rustdoc_ng relating to comment stripping,
along with some other various issues that I found along the way.

The `make doc` command has been altered to generate the new documentation into
the `doc/ng/$(CRATE)` directories.
2013-09-20 22:49:03 -07:00
Graydon Hoare
ef5d537010 doc: add condition tutorial 2013-08-19 16:48:48 -07:00
gifnksm
8e1440c7d4 tutorial: Add Japanese translation 2013-08-13 00:26:49 +09:00
gifnksm
7b1b7f3210 doc: Add -M and -L option to po4a 2013-08-12 22:39:31 +09:00
OGINO Masanori
ad3a69739f Add project information to l10n templates. 2013-07-17 07:48:30 +09:00
Luca Bruno
3177e63dee 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 21:12:00 +02:00
Daniel Micay
659cd55e75 add a tutorial on containers and iterators 2013-06-28 00:24:09 -04:00
Patrick Walton
0c820d4123 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-22 21:57:05 -07:00
Brian Anderson
9847428acf mk: Fix pdf build 2013-04-30 17:45:08 -07:00
Brian Anderson
34f7255afa 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-23 23:52:58 -07:00
Tim Chevalier
d834c0d59d docs: Sketch out rustpkg manual 2013-04-22 18:17:32 -07:00
Young-il Choi
7714d52cd9 mk: cleanup - lib and executable suffix handling 2013-03-02 21:25:12 +09:00
Brian Anderson
15c0c35352 mk: Split target triples into bulid triple + host triples + target triples
For cross compiling to targets that don't want to build a compiler
2013-02-21 17:51:55 -08:00
Graydon Hoare
79dc10dba9 doc: improvements to version-stamp makefile logic. 2013-02-06 14:59:03 -08:00
Daniel Micay
486217d7a2 add missing $(CFG_PYTHON) prefixes 2013-01-03 03:15:35 -05:00
Brian Anderson
e67190a0d2 Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
Graydon Hoare
d1affff623 Reliciense makefiles and testsuite. Yup. 2012-12-10 17:32:58 -08:00
Brian Anderson
fd0de8bfd7 doc: Split out task tutorail. Add links to sub-tutorials 2012-09-22 15:34:01 -07:00
Brian Anderson
82e79f765c docs: Add Niko's borrowed pointers tutorial 2012-09-15 17:09:21 -07:00
Patrick Walton
4e515c14af 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 11:20:04 -07:00
Patrick Walton
69b363e02a doc: Split macros out into a separate tutorial 2012-09-05 11:07:06 -07:00
Kevin Cantu
705f423965 Rename the template for version_info.html 2012-08-20 14:04:12 -07:00
Paul Stansifer
fa882d4295 Add a badge to the tutorial and reference docs indicating which Rust version they pertain to. 2012-07-19 17:09:03 -07:00
Brian Anderson
8be944e89e doc: Remove unused keywords.txt 2012-04-19 20:06:13 -07:00
Graydon Hoare
55bfc5e4f9 Prep docs before pdf. 2012-03-27 13:07:26 -07:00
Graydon Hoare
5487f140cc Tidy up doc make rules. 2012-03-26 18:03:53 -07:00
Brian Anderson
0a347e760f 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 18:59:21 -07:00
Daniel Brooks
29fa4a60fb This path could have spaces in it, so quote it 2012-03-15 16:55:22 -07:00
Brian Anderson
6bab5c07e4 build: Make tutorial and lang ref depend on rust.css 2012-03-10 15:26:09 -08:00
Brian Anderson
93a082149a build: Switch from naturaldocs to rustdoc 2012-03-09 22:56:53 -08:00
Graydon Hoare
c2dba1799f Actually use CFG_NATURALDOCS rather than hardcoding naturaldocs name. 2012-01-19 13:26:59 -08:00
Marijn Haverbeke
df02ca1df9 [makefiles] Don't add css file to set of DOCS targets 2012-01-19 14:19:23 +01:00
Marijn Haverbeke
a4b77758f0 Move tutorial over to a format similar to the reference doc
And adjust highlighting/testing scripts to deal with this.
2012-01-19 13:34:10 +01:00
Graydon Hoare
3074fd591d Tidy tidy 2012-01-18 18:44:06 -08:00
Graydon Hoare
193279daa2 Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now). 2012-01-18 14:14:42 -08:00
Marijn Haverbeke
ba6c94e321 Add a stylesheet to make the reference HTML look a bit prettier 2012-01-18 16:28:31 +01:00
Graydon Hoare
dbd3d6ac09 Move the ifdefs to nest properly. Real clever. 2012-01-17 16:50:13 -08:00
Graydon Hoare
c1bf17ed4f cp -a only. 2012-01-17 15:47:35 -08:00
Graydon Hoare
af4e18d980 Improve the node-doc-building logic. 2012-01-17 14:46:51 -08:00
Grahame Bowland
9be247b9b8 build the tutorial if node.js is available 2012-01-17 23:56:20 +08:00
Graydon Hoare
fefdb63c4c Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it. 2012-01-12 19:10:30 -08:00