Roman's Blog

As I mentioned in my previous post, I did a major rework of django-tinymce4 package. At first, I intended to fix a few features and then submit a pull request to the original package, but I couldn't stop myself and re-wrote almost everything. (...)

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. (...)

There are a number of Python auto-documenting tools in existence, starting with Python's built-in pydoc module. Some time ago Epydoc was a popular tool for auto-generating documentation from Python docstrings but its development was abandoned and it does not support current Python releases, though some popular Python IDEs, like PyDev for Eclipse or PyCharm still support Epytext markup language.

Now Sphinx has become de facto the standard tool for creating documentation for Python programs and libraries, and even the docs for Python itself are created with Sphinx. Docs for third-party Python libraries hosted on Read the Docs, a popular documentation hosting site, are also generated by Sphinx. (...)

This is the first post in my Django-based blog that I've developed myself. I've developed this blog primarily to learn Django web-framework, but I'm going to write in it from time to time when I want to share some thoughts. (...)