IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

UTF-8 isn't mandatory anymore.

Browse Source
This commit is contained in:
Georg Brandl 2008-10-16 20:31:28 +00:00
parent e4306e5f87
commit a857b89a23
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/markup/code.rst
View File

@ -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

8
doc/rest.rst
View File

@ -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?