259e806db6
Targetting at fixing most of #16414. Sorts these alphabetically: * [Crate-only attributes](http://doc.rust-lang.org/rust.html#crate-only-attributes) * [Function-only attributes](http://doc.rust-lang.org/rust.html#function-only-attributes) * [Miscellaneous attributes](http://doc.rust-lang.org/rust.html#miscellaneous-attributes) * [Lint check attributes](http://doc.rust-lang.org/rust.html#lint-check-attributes) * [Built-in Traits](http://doc.rust-lang.org/rust.html#built-in-traits) * [Types](http://doc.rust-lang.org/rust.html#types) * [Deriving](http://doc.rust-lang.org/rust.html#deriving) * [Compiler Features](http://doc.rust-lang.org/rust.html#compiler-features) Doesn't modify these: * [Operators](http://doc.rust-lang.org/rust.html#operators): An alternative sorting is unclear. * [Marker types](http://doc.rust-lang.org/rust.html#marker-types): Could be sorted but uncertain how. See below. * [Stability](http://doc.rust-lang.org/rust.html#stability): Already sorted by stability --- [Marker types](http://doc.rust-lang.org/rust.html#marker-types) has an extra newline above `fail_` which may throw off formatting (see #16412) or it may be for some other reason. If the newline is just a typo, I can just remove it and format this alphabetically like so: ```rust // Sorted alphabetically a_bread b_bread c_bread fail_ fail_bounds_check a_type b_type c_type ``` Marker types is listed as likely to become out of date so I don't know if this is worth doing anyway. [EDIT] modified `Marker types` now and tried to update the language items list. |
||
|---|---|---|
| .. | ||
| complement-bugreport.md | ||
| complement-design-faq.md | ||
| complement-lang-faq.md | ||
| complement-project-faq.md | ||
| favicon.inc | ||
| footer.inc | ||
| full-toc.inc | ||
| guide-container.md | ||
| guide-ffi.md | ||
| guide-lifetimes.md | ||
| guide-macros.md | ||
| guide-pointers.md | ||
| guide-runtime.md | ||
| guide-strings.md | ||
| guide-tasks.md | ||
| guide-testing.md | ||
| guide-unsafe.md | ||
| guide.md | ||
| index.md | ||
| intro.md | ||
| not_found.md | ||
| po4a.conf | ||
| README.md | ||
| rust.css | ||
| rust.md | ||
| rustdoc.md | ||
| tutorial.md | ||
| version_info.html.template | ||
Dependencies
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.
po4a is required for generating translated docs from the master (English) docs.
GNU gettext is required for managing the translation data.
Building
To generate all the docs, just run make docs from the root of the repository.
This will convert the distributed Markdown docs to HTML and generate HTML doc
for the 'std' and 'extra' libraries.
To generate HTML documentation from one source file/crate, do something like:
rustdoc --output-dir 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 manually, you can do something like:
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
(rust.md being the Rust Reference Manual.)
The syntax for pandoc flavored markdown can be found at: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
A nice quick reference (for non-pandoc markdown) is at: http://kramdown.rubyforge.org/quickref.html
Notes for translators
Notice: The procedure described below is a work in progress. We are working on translation system but the procedure contains some manual operations for now.
To start the translation for a new language, see po4a.conf at first.
To generate .pot and .po files, do something like:
po4a --copyright-holder="The Rust Project Developers" \
--package-name="Rust" \
--package-version="0.11.0" \
-M UTF-8 -L UTF-8 \
src/doc/po4a.conf
(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 manual linked from http://www.gnu.org/software/gettext/ . We use UTF-8 as the file encoding of .po files.
When you want to make a commit, do the command below before staging your change:
for f in src/doc/po/**/*.po; do
msgattrib --translated $f -o $f.strip
if [ -e $f.strip ]; then
mv $f.strip $f
else
rm $f
fi
done
This removes untranslated entries from .po files to save disk space.