Changeset 1067


Ignore:
Timestamp:
Aug 12, 2012 7:15:25 PM (10 years ago)
Author:
jemian
Message:
 
Location:
specdomain/trunk/src/specdomain
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • specdomain/trunk/src/specdomain/CHANGES

    r1033 r1067  
    22
    33This file describes user-visible changes between the extension versions.
     4Refer to the TRAC site for details on these tickets noting *specdomain* in the title.
     5(https://subversion.xor.aps.anl.gov/trac/bcdaext/report/1?sort=ticket&asc=1)
     6
     7
     8Version 1.01 (started 2012-07-16)
     9-----------------------------------
     10
     11* refs #13: show a bullet list at the top of the page (alternative to separate pages for each macro file)
     12* fixed #14: "duplicate ID warnings" resolved
    413
    514Version 1.0 (2012-07-16)
     
    716
    817* Initial release.
    9 
    10 
    11 Version 1.01 (started 2012-07-16)
    12 -----------------------------------
    13 
    14 * -tba-
  • specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py

    r1066 r1067  
    330330
    331331class SpecXRefRole(XRefRole):
    332     """ """
     332    """ Cross-reference the roles in specdomain """
    333333   
    334334    def process_link(self, env, refnode, has_explicit_title, title, target):
     335        """Called after parsing title and target text, and creating the
     336        reference node (given in *refnode*).  This method can alter the
     337        reference node and must return a new (or the same) ``(title, target)``
     338        tuple.
     339        """
    335340        key = ":".join((refnode['refdomain'], refnode['reftype']))
    336341        refnode[key] = env.temp_data.get(key)        # key was 'spec:def'
     
    348353
    349354    def result_nodes(self, document, env, node, is_ref):
     355        """Called before returning the finished nodes.  *node* is the reference
     356        node if one was created (*is_ref* is then true), else the content node.
     357        This method can add other nodes and must return a ``(nodes, messages)``
     358        tuple (the usual return value of a role function).
     359        """
    350360        # this code adds index entries for each role instance
    351361        if not is_ref:
Note: See TracChangeset for help on using the changeset viewer.