summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
diff options
context:
space:
mode:
authorLeonard Richardson <leonardr@segfault.org>2019-11-11 11:37:55 -0500
committerLeonard Richardson <leonardr@segfault.org>2019-11-11 11:37:55 -0500
commit64753365df3bedd60cde505db792abb20841ada4 (patch)
treec983c3442d709666eda61d29b4d68f7980d2a85a /doc/source/index.rst
parentce4a5001dcd4e85e95da61969a892d1b3fcd9c3b (diff)
Moved each translation into its own directory.
Diffstat (limited to 'doc/source/index.rst')
-rw-r--r--doc/source/index.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ac7409f..08063a5 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3114,6 +3114,27 @@ You can speed up encoding detection significantly by installing the
the document, but it can save a lot of memory, and it'll make
`searching` the document much faster.
+Translating this documentation
+==============================
+
+New translations of the Beautiful Soup documentation are greatly
+appreciated. Translations should be licensed under the MIT license,
+just like Beautiful Soup and its English documentation are.
+
+There are two ways of getting your translation into the main code base
+and onto the Beautiful Soup website:
+
+1. Create a branch of the Beautiful Soup repository, add your
+ translation, and propose a merge with the main branch, the same
+ as you would do with a proposed change to the source code.
+2. Send a message to the Beautiful Soup discussion group with a link to
+ your translation, or attach your translation to the message.
+
+Use the Chinese or Brazilian Portuguese translations as your model. In
+particular, please translate ``doc/source/index.rst`` file, rather
+than the HTML version of the documentation. This makes it possible to
+publish the documentation in a variety of formats, not just HTML.
+
Beautiful Soup 3
================