diff --git a/mk/docs.mk b/mk/docs.mk index 6d1a3bfa7a3..9a924916ec8 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -216,36 +216,6 @@ endef $(foreach docname,$(DOCS),$(eval $(call DEF_DOC,$(docname)))) -# Localized documentation - -# FIXME: I (huonw) haven't actually been able to test properly, since -# e.g. (by default) I'm doing an out-of-tree build (#12763), but even -# adjusting for that, the files are too old(?) and are rejected by -# po4a. -# -# As such, I've attempted to get it working as much as possible (and -# switching from pandoc to rustdoc), but preserving the old behaviour -# (e.g. only running on the guide) -.PHONY: l10n-mds -l10n-mds: $(D)/po4a.conf \ - $(foreach lang,$(L10N_LANG),$(D)/po/$(lang)/*.md.po) - $(warning WARNING: localized documentation is experimental) - po4a --copyright-holder="The Rust Project Developers" \ - --package-name="Rust" \ - --package-version="$(CFG_RELEASE)" \ - -M UTF-8 -L UTF-8 \ - $(D)/po4a.conf - -define DEF_L10N_DOC -DOC_L10N_TARGETS += doc/l10n/$(1)/$(2).html -doc/l10n/$(1)/$(2).html: l10n-mds $$(HTML_DEPS) $$(RUSTDOC_DEPS_$(2)) - @$$(call E, rustdoc: $$@) - $$(RUSTDOC) $$(RUSTDOC_HTML_OPTS) $$(RUSTDOC_FLAGS_$(1)) doc/l10n/$(1)/$(2).md -endef - -$(foreach lang,$(L10N_LANGS),$(eval $(call DEF_L10N_DOC,$(lang),guide))) - - ###################################################################### # Rustdoc (libstd/extra) ###################################################################### @@ -294,7 +264,3 @@ endif docs: $(DOC_TARGETS) compiler-docs: $(COMPILER_DOC_TARGETS) - -docs-l10n: $(DOC_L10N_TARGETS) - -.PHONY: docs-l10n diff --git a/src/doc/README.md b/src/doc/README.md index 50222973509..3b12ffe8f11 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -6,12 +6,6 @@ document converter, is required to generate docs as HTML from Rust's source code. -[po4a](http://po4a.alioth.debian.org/) is required for generating translated -docs from the master (English) docs. - -[GNU gettext](http://www.gnu.org/software/gettext/) is required for managing -the translation data. - ## Building To generate all the docs, just run `make docs` from the root of the repository. @@ -44,43 +38,3 @@ The syntax for pandoc flavored markdown can be found at: A nice quick reference (for non-pandoc markdown) is at: - http://kramdown.gettalong.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.13.0" \ - -M UTF-8 -L UTF-8 \ - src/doc/po4a.conf -~~~~ - -(the version number must be changed if it is not `0.13.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. diff --git a/src/doc/po4a.conf b/src/doc/po4a.conf deleted file mode 100644 index 80f8b748814..00000000000 --- a/src/doc/po4a.conf +++ /dev/null @@ -1,28 +0,0 @@ -# Add here a list of target languages; po4a will automatically -# generates .po for them and build .md when translated, eg: -# [po4a_langs] es fr it pt_BR -[po4a_langs] ja -[po4a_paths] doc/po/$master.pot $lang:src/doc/po/$lang/$master.po - -# Add here below all source documents to be translated -[type: text] src/doc/complement-bugreport.md $lang:doc/l10n/$lang/complement-bugreport.md -[type: text] src/doc/complement-design-faq.md $lang:doc/l10n/$lang/complement-design-faq.md -[type: text] src/doc/complement-lang-faq.md $lang:doc/l10n/$lang/complement-lang-faq.md -[type: text] src/doc/complement-project-faq.md $lang:doc/l10n/$lang/complement-project-faq.md -[type: text] src/doc/guide-container.md $lang:doc/l10n/$lang/guide-container.md -[type: text] src/doc/guide-ffi.md $lang:doc/l10n/$lang/guide-ffi.md -[type: text] src/doc/guide-ownership.md $lang:doc/l10n/$lang/guide-ownership.md -[type: text] src/doc/guide-macros.md $lang:doc/l10n/$lang/guide-macros.md -[type: text] src/doc/guide-plugin.md $lang:doc/l10n/$lang/guide-plugin.md -[type: text] src/doc/guide-pointers.md $lang:doc/l10n/$lang/guide-pointers.md -[type: text] src/doc/guide-strings.md $lang:doc/l10n/$lang/guide-strings.md -[type: text] src/doc/guide-tasks.md $lang:doc/l10n/$lang/guide-tasks.md -[type: text] src/doc/guide-testing.md $lang:doc/l10n/$lang/guide-testing.md -[type: text] src/doc/guide-unsafe.md $lang:doc/l10n/$lang/guide-unsafe.md -[type: text] src/doc/guide-crates.md $lang:doc/l10n/$lang/guide-crates.md -[type: text] src/doc/guide-error-handling.md $lang:doc/l10n/$lang/guide-error-handling.md -[type: text] src/doc/guide.md $lang:doc/l10n/$lang/guide.md -[type: text] src/doc/index.md $lang:doc/l10n/$lang/index.md -[type: text] src/doc/intro.md $lang:doc/l10n/$lang/intro.md -[type: text] src/doc/rust.md $lang:doc/l10n/$lang/rust.md -[type: text] src/doc/rustdoc.md $lang:doc/l10n/$lang/rustdoc.md