ABlog API

ablog Package

Functions

setup(app)

Setup ABlog extension.

ablog.blog Module

Classes

Blog(app)

Handle blog operations.

Post(blog, docname, info)

Handle post metadata.

Collection(catalog, label[, name, href, …])

Posts sharing a label, i.e. tag, category, author, or location.

Class Inheritance Diagram

Inheritance diagram of ablog.blog.Blog, ablog.blog.Post, ablog.blog.Collection

ablog.commands Module

Functions

ablog_build([builder, sourcedir, website, …])

ablog_clean([website, doctrees, deep])

ablog_serve([website, port, view, rebuild, …])

ablog_deploy(website[, message, …])

ablog_main()

Ablog Main.

ablog.post Module

Functions

purge_posts(app, env, docname)

Remove post and reference to it from the standard domain when its document is removed or changed.

process_posts(app, doctree)

Process posts and map posted document names to post details in the environment.

process_postlist(app, doctree, docname)

Replace PostList nodes with lists of posts.

generate_archive_pages(app)

Generate archive pages for all posts, categories, tags, authors, and drafts.

generate_atom_feeds(app)

Generate archive pages for all posts, categories, tags, authors, and drafts.

register_posts(app)

Register posts found in the Sphinx build environment.

Classes

PostNode([rawsource])

Represent post directive content and options in document tree.

PostList([rawsource])

Represent postlist directive converted to a list of links.

UpdateNode([rawsource])

Represent update directive.

PostDirective(name, arguments, options, …)

Handle post directives.

UpdateDirective(name, arguments, options, …)

PostListDirective(name, arguments, options, …)

Handle postlist directives.

CheckFrontMatter(document[, startnode])

Check the doctree for frontmatter meant for a blog post.

Class Inheritance Diagram

Inheritance diagram of ablog.post.PostNode, ablog.post.PostList, ablog.post.UpdateNode, ablog.post.PostDirective, ablog.post.UpdateDirective, ablog.post.PostListDirective, ablog.post.CheckFrontMatter

ablog.start Module

Functions

generate(d[, overwrite, silent])

Borrowed from Sphinx 1.3b3.

ask_user(d)

Borrowed from Sphinx 1.3b3.

ablog_start(**kwargs)

Comments

comments powered by Disqus