document converter, is required to generate docs as HTML from Rust's
source code.
-[Node.js](http://nodejs.org/) is also required for generating HTML from
-the Markdown docs (reference manual, tutorials, etc.) distributed with
-this git repository.
-
[po4a](http://po4a.alioth.debian.org/) is required for generating translated
docs from the master (English) docs.
To generate HTML documentation from one source file/crate, do something like:
~~~~
-rustdoc --output-dir html-doc/ --output-format html ../src/libstd/path.rs
+rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
~~~~
(This, of course, requires a working build of the `rustdoc` tool.)
# Additional notes
-To generate an HTML version of a doc from Markdown without having Node.js
-installed, you can do something like:
+To generate an HTML version of a doc from Markdown manually, you can do
+something like:
~~~~
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
~~~~
po4a --copyright-holder="The Rust Project Developers" \
--package-name="Rust" \
- --package-version="0.10-pre" \
+ --package-version="0.11.0" \
-M UTF-8 -L UTF-8 \
- po4a.conf
+ src/doc/po4a.conf
~~~~
-(the version number must be changed if it is not 0.10-pre now.)
+(the version number must be changed if it is not 0.11.0 now.)
Now you can translate documents with .po files, commonly used with gettext. If
you are not familiar with gettext-based translation, please read the online
change:
~~~~
-for f in doc/po/**/*.po; do
+for f in src/doc/po/**/*.po; do
msgattrib --translated $f -o $f.strip
if [ -e $f.strip ]; then
mv $f.strip $f