diff options
| -rw-r--r-- | doc/markup/code.rst | 5 | ||||
| -rw-r--r-- | doc/rest.rst | 8 |
2 files changed, 6 insertions, 7 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst index cf70be27..299ab0bc 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -106,8 +106,9 @@ Includes :language: ruby :linenos: - Include files are assumed to be encoded in UTF-8. If the file has a different - encoding, you can specify it with the ``encoding`` option:: + Include files are assumed to be encoded in the :confval:`source_encoding`. + If the file has a different encoding, you can specify it with the + ``encoding`` option:: .. literalinclude:: example.py :encoding: latin-1 diff --git a/doc/rest.rst b/doc/rest.rst index 946f54f5..9820aea2 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -265,10 +265,8 @@ Source encoding Since the easiest way to include special characters like em dashes or copyright signs in reST is to directly write them as Unicode characters, one has to -specify an encoding: - -All documentation source files must be in UTF-8 encoding, and the HTML -documents written from them will be in that encoding as well. +specify an encoding. Sphinx assumes source files to be encoded in UTF-8 by +default; you can change this with the :confval:`source_encoding` config value. Gotchas @@ -278,6 +276,6 @@ There are some problems one commonly runs into while authoring reST documents: * **Separation of inline markup:** As said above, inline markup spans must be separated from the surrounding text by non-word characters, you have to use - an escaped space to get around that. + a backslash-escaped space to get around that. .. XXX more? |