Articles

In Sphinx 4.4 a new external role was added for use with the intersphinx references, which changes the syntax of intersphinx references. The old format of a basic reference was:

I was looking for a way to host my comments on GitHub Issues when I stumbled upon Paul Knopf’s blog post where he was able to generate his blog post’s comments server side. Since I didn’t want to use client-side scripting to render and post comments or rely on a GitHub App like Utterances, I decided to adapt his approach to my Jekyll based blog.

Providing readers with a low friction way of giving feedback on a specific page is a great way to guide where to spend maintenance efforts over a large collection of pages.

Sphinx themes can provide a great out-of-the-box experience, but sometimes there is a need to extend its functionality in ways that are reusable across projects and more likely to survive upgrades. This article covers a variety of ways to achieve this using the following methods:

When maintaining a website, there are some key metrics to keep track of, both manually through custom reports and automatically through custom alerts, that are not a part of the basic “out of the box” Google Analytics configuration.

One of the great things about Sphinx, is that it natively provides internationalization (i18n) mechanisms to facilitate translation using the common gettext method. The gettext files can be translated a number of different ways, but I have had great results using Zanata, a separate open source project that facilitates community driven translation.

If you have ever set up a sphinx project you have probably reached the point where you want to start automating the build and deploy part of the creation process. This can be done several ways, but I chose git hooks going into a Jenkins pipeline using Docker agents. I am also doing this as a single branch deploy using the master branch, how you get your source onto master is up to you.

After reading Google Analytics developer Philip Walton’s post on The Google Analytics Setup I Use on Every Site I Build I realized I didn’t know nearly as much as I had originally thought about setting up Google Analytics.

I recently tried my hand at cooperative small-scale urban “market gardening” as a hobby and thought I would document it as a comparison to writing software – because who doesn’t like analogies.