Blog Archive, February 2016

This is Part 2 of my Sphinx autodocumentation tutorial. Part 1 of this tutorial you can find by the following link:

Autodocumenting your Python code with Sphinx - part 1

As I've mentioned in Part 1, Sphinx as an automatic documentation generator for Python is neither convenient nor simple. But it is de facto the tool for documenting Python programs and libraries, so unfortunately we have to deal with its weaknesses.

In Part 1 I've demonstrated you how to write Sphinx-compatible docstrings for your Python objects, and now I'll show you how to set-up a Sphinx project to generate documentation from your code docstrings. (...)

I'm still polishing this blog CMS. One of the major "under the hood" improvements that I've made recently is the upgrade of TinyMCE content editor from v.3 to v.4. For that I've done a major rework of django-tinymce4 package and fixed almost all features, including spellchecker and integration with django-filebrowser / django-filebrowser-no-grappelli packages. I'm going to submit a pull request with my changes, but that will be later, when I get all things in order, including updated documentation for django-tinymce4.

As a part of this improvement I've developed a spoiler plugin for TinyMCE 4 that allows to add spoiler blocks to authored text, that is blocks of text that are initially collapsed and can be expanded by mouse click. (...)