<== blog page - 3/3 Blog automation (4) documentation (8) example (2) latex (2) notebook (4) sphinx (10)
blog page - 3/3¶
Sphinx fails because of some weird encoding¶
2015-04-07
I have been generating many times the documentation of this module and I can tell I went through many errors due to encoding, French accents may be sometimes painful to deal with. However, I now check every time that every file I produce has either no encoding, either is encoded with utf-8 and no BOM. After I checked that, I’m sure the error come from something else.
The issue I had with Sphinx is not necessarily a crash but also
a label which was not takein into account.
This label was written on the first line of the line.
I replaced that label by a comment (.. comment.).
The comment showed on the generated HTML page but it disappear
after I removed the BOM from the original RST file.
An example of a blog post included in the documentation¶
2015-04-04
This blog post is an example of a blogpost which can be added to the documentation. Unfortunately, it does not rely on an existing python blog generator as it was difficult to entirely change the existing framework and to keep track on references.
It is just a rst file which starts with a header like the following:
.. blogpost::
:title: An example of a blog post included in the documentation
:keywords: example, blogpost, documentation
:date: 2015-04-04
:categories: documentation, example
However, you can check some of the following to power your blog: What’s the best available static blog/website generator in Python or this page which gathers many framework to build a static website: StaticGen Top Open-Source Static Site Generators.
<== blog page - 3/3 2015-04 (8) 2015-05 (4) 2015-08 (2) 2015-10 (1) 2015-12 (3) 2016-01 (1) 2016-02 (3) 2016-04 (1) 2016-06 (1)