|
Original |
Translation |
|
387
|
Every explicit markup block which isn't a valid markup construct (like the footnotes above) is regarded as a comment.
|
|
|
388
|
|
|
|
389
|
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:
|
|
|
390
|
All Python documentation source files must be in UTF-8 encoding, and the HTML documents written from them will be in that encoding as well.
|
|
|
391
|
|
392
|
There are some problems one commonly runs into while authoring reST documents:
|
|
|
393
|
**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.
|
|
|
394
|
|
|
|
395
|
The Python documentation should follow the `Apple Publications Style Guide`_ wherever possible. This particular style guide was selected mostly because it seems reasonable and is easy to get online.
|
|
|
396
|
Topics which are not covered in Apple's style guide will be discussed in this document.
|
|