A Sphinx extension that converts any documentation or personal website project into a full-fledged blog.
Project description
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:
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' and 'sphinx.ext.intersphinx' to the list of extensions
extensions = [
'...',
'ablog',
'sphinx.ext.intersphinx',
]
# 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::
:list-style: circle
:category: Manual
:format: {title}
:sort: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
Built Distribution
File details
Details for the file ablog-0.10.4.tar.gz.
File metadata
- Download URL: ablog-0.10.4.tar.gz
- Upload date:
- Size: 753.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.1 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 31535e996d3b264a0e77504d0dec8c8657802eabd758671884673546f9800528 |
|
| MD5 | e0747d49dc88f875311db21b6d8ecfd9 |
|
| BLAKE2b-256 | 80f78413250bd988cda4c3bfb9adc01e14fa111c2920b31a4fc4f7fc73992301 |
File details
Details for the file ablog-0.10.4-py3-none-any.whl.
File metadata
- Download URL: ablog-0.10.4-py3-none-any.whl
- Upload date:
- Size: 47.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.1 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c60e6ba3dbdc00739b770509f3220347a78ca1edd15296db5f9125859d9a9f39 |
|
| MD5 | f91493dc3b8840d2048105dd3b9862ff |
|
| BLAKE2b-256 | 801c604514147effaf2e2426fb7e567b97c27caee49472cd24b0df046b99736f |
