.. _f-blogpostlist: module ``sphinxext.blog_post_list`` =================================== .. inheritance-diagram:: pyquickhelper.sphinxext.blog_post_list Short summary +++++++++++++ module ``pyquickhelper.sphinxext.blog_post_list`` Helpers to build :epkg:`RST` extra files inserted in the documentation. :githublink:`%|py|6` Classes +++++++ +-----------------------------------------------------------------------------+--------------------------------------+ | class | truncated documentation | +=============================================================================+======================================+ | :class:`BlogPostList ` | Defines a list of :class:`BlogPost`. | +-----------------------------------------------------------------------------+--------------------------------------+ Properties ++++++++++ +-------------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +=========================================================================+=========================+ | :meth:`Lang ` | Returns the language. | +-------------------------------------------------------------------------+-------------------------+ Static Methods ++++++++++++++ +-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | staticmethod | truncated documentation | +=========================================================================================================================+========================================================+ | :meth:`category2url ` | Removes accents and spaces to get a clean url. | +-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | :meth:`divide_list ` | Divides a list into buckets of *division* items. | +-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | :meth:`produce_aggregated_post_page ` | Writes the content of an aggregate page of blog posts. | +-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ | :meth:`write_aggregated_post_list ` | Writes list of posts in an aggregated manners. | +-------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------+ Methods +++++++ +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +=======================================================================================================================+============================================================================================================+ | :py:meth:`__getitem__ ` | usual | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Creates a list of :class:`BlogPost`, we assume each blog post belongs to a subfolder ``YYYY``. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :py:meth:`__iter__ ` | Iterates on :class:`BlogPost`. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | Returns the number of blog posts. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_categories ` | Extracts the categories. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_categories_group ` | Extracts the categories with the posts associated to it. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_files ` | Extracts the files. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_image ` | Returns the local path to an image in this folder. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_keywords ` | Extracts the categories. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_months ` | Extracts the months. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_months_group ` | Extracts the months with the posts associated to it. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_rst_links_down ` | Builds the :epkg:`rst` links to months or categories to displays the bottom of the aggregated pages. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`get_rst_links_up ` | Builds the :epkg:`rst` links to months or categories to displays at the beginning of the aggregated pages. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated ` | Writes posts in a aggregated manner (post, categories, months). | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_categories ` | Writes posts in a aggregated manner per categories. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_chapters ` | Writes links to post per categories and per months. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_index ` | Writes an index. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_months ` | Writes posts in a aggregated manner per months. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | :meth:`write_aggregated_posts ` | Writes posts in a aggregated manner. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.blog_post_list :members: :special-members: __init__ :show-inheritance: