Skip to content
Software that runs
Python HTML
Find file
New pull request
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

README.rst software

Very specific too-much-hardcoded code to manage my website.

Buildout will initially fail. Run the following command once to get symlinks set up:

$ bin/buildout install symlinks

Ideas for cleaning up my weblog code

From time to time people ask me how I've made my blog with sphinx. Also because I've got the top rated answer on stackoverflow for the "weblog with sphinx" question: .

Note: there's that uses sphinx and looks quite polished. At least it is currently very much more reusable than my code :-)

Ablog works by marking certain pages as blog posts. My code works from a yyyy/mm/dd/entry.txt structure. Ablog also seems to "take over" your entire sphinx site instead of my code, that hardcodes itself neatly into some corner :-)

At the "django under the hood 2015" sprint, Eric Holscher pointed me at ablog and also gave me some other tips.

One of the not-standard-sphinx things I do is that I have a "preprocessor script" that generates index.txt files in all the subdirectories. It also generates a tags/tagname.txt file per tag. All of those files are just a title and a TOC pointing at the files.

TODO items so I can do to do away with the preprocessing:

  • I can have a global TOC that automatically includes everything in my weblog directory. Apparently there's a :glob: configuration option for TOC, so I probably can put */*/*/*.txt in there and delete all my index.txt files.

  • Instead of creating index.txt and tag "input files" beforehand and letting Sphinx take care of the rest, I can also generate "output files". So programmatically insert docs and nodes (or whatever the sphinx terminology is) into the doctree and let sphinx render it to the output html directory!

  • For this, I need an accurate list, probably inside some sphinx memory structure, of blog posts and tags and their links.

  • My sphinx "app" registers directives and connects to two signals at the moment. I should enhance this with other signals like doctree-read and doctree-resolved, I think. See ablog/ for examples. This could do away with the custom scripts I have to call.

    Actually... I could perhaps even use it to retain my index.txt generation, only now I fire it from within sphinx.... :-) For this, the builder-inited event seems best.

Something went wrong with that request. Please try again.