RSS 2015-04 - 1/1 Blog notebook (8) sphinx (13)


2015-04 - 1/1

Visualize differences between two files in a notebook

2015-04-23

It is now possible to visualize the differences between two files directly from a notebook:

post

Producing a version for Python 2.7 from Python 3

2015-04-17

I tried to make most of the unit tests run under Python 2.7. Most of the function deals with strings for the documentation and it is a real pain to think again about str, unicode, bytes. Some of the functions only works in Python 3 but the goal was more to see what needed to be done.

post

Migration to IPython 3.1

2015-04-16

It took me some time to do the migration to IPython 3.1. The code which automatically generates the documentation had to be updated to follow the new format of the notebooks. I had to redo the configuration of ipython to have the graph inline… I hope ipython does not rename itself into jupyter. The design is better but the notebooks crash from time to time. I guess the code becomes better each time a migration happens. But it takes quite some time. However, the changes are not reversible. Ipython needs to be updated otherwise the automated generation of the documentation will not work. For Jenkins, just remind that the server needs your credentials othewise it does not easily find pandoc.

post

Conversion to latex is taking for ever

2015-04-16

The unit tests are now scheduled using Jenkins. When the documentation is generated for the first time after a fresh installation of the machine (latex, sphinx…), the compilation can take for ever. This is due to extra packages needed by latex. When the process is run from a command line, a windows shows up asking for approval before going on installing the missing latex packages. As this command line is showing up in the output, it is just needed to executed from a command line window to import the missing package. After this short break, the latex compilation runs fine on Jenkins.

post

Anaconda does not have the latest version of Sphinx

2015-04-16

As of today, when I type conda update sphinx, The Anaconda distribution does not upgrade to 1.3 and I need it to get the extension sphinx.ext.napoleon. So I need to type pip install sphinx --upgrade instead.

post

Insert plot from bokeh in the documentation

2015-04-12

As graphs from matplotlib, graphs from bokeh can be inserted in the documentation with the extension bokeh.sphinxext.bokeh_plot.

post

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.

post

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.

post


RSS 2015-04 - 1/1 2019-11 (1) 2020-08 (2) 2020-09 (1) 2021-01 (1) 2022-03 (1)