Skip to content
Permalink
Browse files

Document path_handler_docstrings better

Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information...
Kwpolska committed Jan 9, 2017
1 parent 6eeac4f commit 17d00a11f81c04532f3cff5c1dcf7dc8128a31af
Showing with 6 additions and 1 deletion.
  1. +6 −1 nikola/plugin_categories.py
@@ -495,6 +495,7 @@ class Taxonomy(BasePlugin):
classification_name = "taxonomy":
The classification name to be used for path handlers.
Must be overridden!
overview_page_items_variable_name = "items":
When rendering the overview page, its template will have a list
@@ -592,7 +593,11 @@ class Taxonomy(BasePlugin):
pages.
path_handler_docstrings:
A dictionary of docstrings for path handlers. See eg. nikola.py for examples.
A dictionary of docstrings for path handlers. See eg. nikola.py for
examples. Must be overridden, keys are "taxonomy_index", "taxonomy",
"taxonomy_atom", "taxonomy_rss" (but using classification_name instead
of "taxonomy"). If one of the values is False, the corresponding path
handler will not be created.
"""

name = "dummy_taxonomy"

0 comments on commit 17d00a1

Please sign in to comment.
You can’t perform that action at this time.