RSS blog page - 1/1 Blog documentation (3) example (2)

blog page - 1/1

Make a reference to a blog post


Option lid to the directive blogpost to specify a label. The documentation can now refer to it.

.. blogpost::
    :title: Make a reference to a blog post
    :keywords: reference, blog, post
    :date: 2016-06-11
    :categories: documentation
    :lid: label-to-this-blogpost

And to add a link:



Another example for a blog post


It just contains a link to a class of this module: myclass. A link to the post should follow when this text is inserted into an aggregated page.


An example of a blog post included in the documentation


This blog post is an example of a blogpost which can be added to the documentation. Unfortunately, it does not rely on an existing python blog generator as it was difficult to entirely change the existing framework and to keep track on references.

It is just a rst file which starts with a header like the following:

.. blogpost::
    :title: An example of a blog post included in the documentation
    :keywords: example, blogpost, documentation
    :date: 2015-04-04
    :categories: documentation, example

However, you can check some of the following to power your blog: What’s the best available static blog/website generator in Python or this page which gathers many framework to build a static website: StaticGen Top Open-Source Static Site Generators.


RSS blog page - 1/1 2015-04 (2) 2016-06 (1)