posty.renderer package

Submodules

• posty.renderer.atom module
  • AtomRenderer
    • AtomRenderer.filename
    • AtomRenderer.output()
    • AtomRenderer.url()
• posty.renderer.base module
  • Renderer
    • Renderer.ensure_output_path()
    • Renderer.render_site()
• posty.renderer.feed module
  • FeedRenderer
    • FeedRenderer.output()
    • FeedRenderer.render_posts()
    • FeedRenderer.render_site()
    • FeedRenderer.url()
• posty.renderer.html module
  • HtmlRenderer
    • HtmlRenderer.render_page()
    • HtmlRenderer.render_post()
    • HtmlRenderer.render_posts()
    • HtmlRenderer.render_site()
    • HtmlRenderer.render_site_posts()
    • HtmlRenderer.render_site_tags()
• posty.renderer.json module
  • JsonRenderer
    • JsonRenderer.render_site()
• posty.renderer.posty1_redirect module
  • Posty1RedirectRenderer
    • Posty1RedirectRenderer.render_site()
• posty.renderer.rss module
  • RssRenderer
    • RssRenderer.filename
    • RssRenderer.output()
    • RssRenderer.url()
• posty.renderer.util module
  • absolute_url_func()
  • markdown_func()
  • media_url_func()

Module contents

class posty.renderer.AtomRenderer(site: Site, output_path: str = 'build')

Bases: FeedRenderer

Renderer that outputs an Atom feed XML file

filename = 'atom.xml'

output() → None

Output the Atom feed file

url() → Any

Return the URL to this feed file

class posty.renderer.HtmlRenderer(site: Site, output_path: str = 'build')

Bases: Renderer

Renderer that outputs HTML files

render_page(page: Page, template_name: str = 'page.html') → None

Parameters:

page – a Page object

render_post(post: Post, template_name: str = 'post.html') → None

Parameters:

post – a Post object

render_posts(posts: list[Post], prefix: str = '', template_name: str = 'posts.html') → None

Render a list of posts as sets of pages where each page has num_posts_per_page posts. Each page of posts will be rendered to the path page/:page/index.html relative to the Renderer output_path

If prefix is given, add that will be put in between the output_path and page path. For example if the prefix is ‘tags/foo/’ then a page path would look like ‘tags/foo/page/:page/index.html’

render_site() → None

Given a Site object, render all of its components

Parameters:

site – a loaded Site object

render_site_posts() → None

Renders all of the multi-post pages, N per page

render_site_tags(template_name: str = 'posts.html') → None

Renders all of the per-tag multi-post pages, N per page

class posty.renderer.JsonRenderer(site: Site, output_path: str = 'build')

Bases: Renderer

Renderer that outputs a JSON representation of the Site to site.json within the output directory

render_site() → None

Render the Site to site.json

class posty.renderer.Posty1RedirectRenderer(site: Site, output_path: str = 'build')

Bases: Renderer

Renderer which creates pages to redirect old Posty1 URLs to new Posty2 URLs

Old Posty1 post URLs are in the form of: /:year/:month/:old_slug.html

Posty2 URLs are in the form of: /:year/:month/:slug/index.html

render_site() → None

class posty.renderer.RssRenderer(site: Site, output_path: str = 'build')

Bases: FeedRenderer

Renderer that outputs a RSS feed XML file

filename = 'rss.xml'

output() → None

Output the RSS feed file

url() → Any

Return the URL to this feed file