ABlog for blogging with Sphinx
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
ablog
docs
.gitignore
.pep8speaks.yml
.rtd-environment.yml
.travis.yml
LICENSE.rst
MANIFEST.in
Makefile
README.rst
appveyor.yml
readthedocs.yml
setup.py

README.rst

ABlog for Sphinx

https://travis-ci.org/sunpy/ablog.svg?branch=master https://circleci.com/gh/sunpy/ablog.svg?style=svg https://ci.appveyor.com/api/projects/status/cmmiadqoy5lx7l78?svg=true)

** Please note that is an official new home of** Ahmet Bakan's Ablog Sphinx extension. ** This version is maintined and tested with various verisons of Python and Sphinx. ** ** New features are unlikely. **

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

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:

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/sunpy/ablog.png?branch=devel
      :target: http://travis-ci.org/#!/sunpy/ablog

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

.. toctree::
   :hidden:
   :glob:

   */*