ABlog for blogging with Sphinx
Project description
ABlog is a Sphinx extension that converts any documentation or personal website project into a full-fledged blog with:
Looking for an example? Take a look at ABlog documentation where each manual page and release note is a blog post ;)
Installation
You can install ABlog using pip:
pip install -U ablog
This will also install Sphinx, Alabaster, and Werkzeug, respectively required for building your website, making it look good, and generating feeds.
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: enABlog 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:: 5
:category: Manual
:sort:For ABlog documentation, this converts to the following where you can find more about configuring and using ABlog:
For existing projects, it is important to note that ABlog does not intertere with any Sphinx operations. Since you can post any page from any folder, you do not need to change how you organize project contents.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file ablog-0.5.1.tar.gz.
File metadata
- Download URL: ablog-0.5.1.tar.gz
- Upload date:
- Size: 28.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e91a1101f272e7c524c15ad7df84b80ea1046ef01fcbe296f7820e8c96dd7860 |
|
| MD5 | b80fda9e68fe956c086e94341e322324 |
|
| BLAKE2b-256 | bf3e9f1b8fbe005389fb1bd6bc8acb79bd3cde3d0d2b77649a604e48131acb0e |
