github_docs_index.index_link module¶
-
class
github_docs_index.index_link.
IndexLink
[source]¶ Bases:
object
Base class to represent documents that will be linked in the index page.
-
rst_line
¶ Return the rsStructuredText link/line for this link; this will be used as an item in the document list. This should be a hyperlink to the document URL with the appropriate title, optionally followed by a hyphen and the (~1 sentence) description if available. i.e.:
or:
title - Description goes here.Returns: rst link to document, with optional description Return type: str
-
sort_datetime
¶ Return a datetime.datetime instance to be used when sorting documents by creation/update time.
Returns: creation/modification time of the document for chronological sorting Return type: datetime.datetime
-