Skip to main content

An extension to Sphinx for managing a blog or static website

Project description

Description:

An extension to Sphinx for managing blogs and static websites.

Status:
Alpha - incomplete, not well tested, breaking changes likely
Python Support:

2.7, further compatibility to come in beta

Chephren is an extension for Sphinx that adds features for managing static websites that are not software documentation. Sphinx is a great tool for documenting software projects, but it is missing some common features that would make it just as good for managing static websites. Features provided by Chephren include:

  • Marking a distinction between “posts” and utility pages like the search or about page

  • Allow posts to bypass the “not found in any toctree” warning

  • RSS feed for your posts

  • Date-based archive page for your posts

  • Category-based archive page for your posts

What’s Missing

Lots of planned features don’t yet exist, even features you might expect. Here’s a list of things you cannot do (yet).

  • Rename the archive pages (you’re stuck with blog-bydate and blog-bycategory for now)

  • Create a separate page for each category

  • Paginate the feed

  • Produce a feed in any format except Atom (but Atom is widely supported)

  • Create a traditional-looking blog home page (without custom coding anyway)

  • Apply a custom template to a post

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chephren-0.1.0.tar.gz (27.9 kB view hashes)

Uploaded source

Built Distribution

chephren-0.1.0-py2-none-any.whl (10.6 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page