1. Hong Minhee
  2. sphinxcontrib-httpdomain


Sebastian Wiesner  committed 7997ffd

Document classes used by issuetracker extension to style HTML output

  • Participants
  • Parent commits d274e83
  • Branches default

Comments (0)

Files changed (1)

File issuetracker/doc/index.rst

View file
  • Ignore whitespace
    instance, you might use ``:issue:`{issue.title} (#{issue.id}) <10>``` to use
    the title and the id of the issue ``10`` as reference title.
-The extension fetches information about referenced issues from the configured
-tracker, and so marks closed issues by striking them through in HTML output.
-Moreover you can use parts of this issue information (e.g. the issue title) in
-the reference title.
+Information about the issue (like the title) is retrieved from the configured
+issue tracker.  Aside of providing it for reference titles, the extension also
+uses this information to mark closed issues in HTML output by striking the
+reference text through.  For this purpose, a stylesheet is added to the
+generated HTML.
+You can provide your own styles for issue references by adding them to the
+``.xref.issue`` and ``.xref.issue.closed`` selectors (the latter are closed
+issues).  For instance, the following stylesheet uses red color for open, and
+green color for closed issues::
+   .xref.issue {
+       color: green;
+   }
+   .xref.issue.closed {
+       color: red;
+   }
 Issue ids in plain text