Skip to content
ABlog for blogging with Sphinx
Python HTML Makefile
Branch: devel
Clone or download
lordnapi Merge pull request #82 from abakan/revert-77-devel
Revert "tried to operate in a multi-language environment"
Latest commit 7fb9fcb Feb 28, 2017

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ablog Revert "tried to operate in a multi-language environment" Feb 28, 2017
docs missing word Oct 20, 2016
.gitignore Updated docs: fontawesome_link_cdn is now an URL Jul 29, 2015
.travis.yml Added Pytho 3.5 testing to travis config. Apr 23, 2016
LICENSE.txt Added license. Apr 28, 2014
MANIFEST.in Fixes, revisions. Feb 1, 2015
Makefile Changed docs to use source. Oct 24, 2015
README.rst Added post list link style, removed badges that don't display. Oct 12, 2015
setup.py Update setup.py Jan 5, 2016

README.rst

ABlog for Sphinx

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

Installation

You can install ABlog using pip:

pip install -U 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:

For ABlog documentation, this converts to the following where you can find more about configuring and using ABlog:

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


.. only:: html

   .. image:: https://secure.travis-ci.org/abakan/ablog.png?branch=devel
      :target: http://travis-ci.org/#!/abakan/ablog

   .. image:: https://readthedocs.org/projects/ablog/badge/?version=latest
      :target: http://ablog.readthedocs.org/


.. toctree::
   :hidden:
   :glob:

   */*
You can’t perform that action at this time.