ablog 0.10.1

A Sphinx extension that converts any documentation or personal website project into a full-fledged blog.

Note

Please note that is an official new home of Ahmet Bakan’s Ablog Sphinx extension. This version is maintined with the aim to keep it working for SunPy’s website and thus new features are unlikely.

ABlog

ABlog is a Sphinx extension that converts any documentation or personal website project into a full-fledged blog with:

• Atom feeds

• Archive pages

• Blog sidebars

• Disqus integration

• Font-Awesome integration

• Easy GitHub Pages deploys

• Jupiter Notebook Support for blog posts

Installation

You can install ABlog using pip:

pip install -U ablog

or anaconda:

conda config --add channels conda-forge
conda install ablog

This will also install Sphinx, Alabaster, Werkzeug, and Invoke respectively required for building your website, making it look good, generating feeds, and running deploy commands.

Getting Started

If you are starting a new project, see ABlog Quick Start guide.

If you already have a project, enable blogging by making following changes in conf.py:

# 1. Add 'ablog' to list of extensions
extensions = [
    '...',
    'ablog'
]

# 2. Add ablog templates path
import ablog

# 2a. if `templates_path` is not defined
templates_path = [ablog.get_html_templates_path()]

# 2b. if `templates_path` is defined
templates_path.append(ablog.get_html_templates_path())

How it works

If you are new to Sphinx and reStructuredText markup language, you might find reStructuredText Primer useful. Once you have content (in .rst files), you can post any page using the post directive as follows:

.. post:: Apr 15, 2014
   :tags: earth, love, peace
   :category: python
   :author: me
   :location: SF
   :language: en

ABlog will index all files posted as above and list them in archives and feeds specified in :tag:, :category:, etc. options.

You can also include a list of posts using postlist directive:

.. postlist::
   :list-style: circle
   :category: Manual
   :format: {title}
   :sort: