Merge pull request #47 from markstory/issue-44

Fix prefix-less link generation for properties and classes

Author: markstory

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
         pip install -r requirements.txt
         pip install .
 
-    - name: Build Test
+    - name: Build test/
       run: |
         cd test && make html SPHINXOPTS='-W'
 

sphinxcontrib/phpdomain.py

@@ -541,16 +541,15 @@ def process_link(self, env, refnode, has_explicit_title, title, target):
             if title.startswith("::"):
                 title = title[2:]
             target = target.lstrip('~')  # only has a meaning for the title
-            # if the first character is a tilde, don't display the module/class
-            # parts of the contents
-            if title[0:1] == '~':
-                m = re.search(r"(?:.+[:]{2}|(?:.*?\\{2})+)?(.*)\Z", title)
+
+            # If the first char is ~ don't display the leading namespace & class.
+            if title.startswith('~'):
+                m = re.search(r"(?:.+[:]{2}|(?:.*?\\{1,2})+)?(.*)\Z", title)
                 if m:
                     title = m.group(1)
 
-        if not title.startswith("$"):
-            refnode['php:namespace'] = env.temp_data.get('php:namespace')
-            refnode['php:class'] = env.temp_data.get('php:class')
+        refnode['php:namespace'] = env.temp_data.get('php:namespace')
+        refnode['php:class'] = env.temp_data.get('php:class')
 
         return title, target
 

test/test_doc.rst

@@ -166,7 +166,7 @@ Test Case - Global symbols with no namespaces
 
 :php:func:`DateTime::getLastErrors()`
 
-:php:func:`~DateTime::setDate()`
+:php:func:`DateTime::setDate()`
 
 :php:func:`DateTime::ATOM`
 
@@ -198,11 +198,21 @@ Test Case - Global symbols with no namespaces
 
 :php:func:`LogTrait::log()`
 
-.. php:namespace:: LibraryName
+Test Case - Prefix less links
+-----------------------------
+
+The following links should not be prefixed with a classname.
+
+:php:func:`~DateTime::setDate()`
+
+:php:attr:`~DateTime::$testattr`
+
 
 Namespaced elements
 ===================
 
+.. php:namespace:: LibraryName
+
 .. php:function:: namespaced_function($one[, $two])
 
     A function in a namespace
@@ -308,6 +318,8 @@ Namespaced elements
 Test Case - not including namespace
 -----------------------------------
 
+Within a namespace context you don't need to include the namespace in links.
+
 :php:ns:`LibraryName`
 
 :php:func:`namespaced_function()`
@@ -316,9 +328,6 @@ Test Case - not including namespace
 
 :php:class:`LibraryClass`
 
-
-:php:class:`~LibraryName\\LibraryClass`
-
 :php:func:`LibraryClass::instanceMethod`
 
 :php:func:`LibraryClass::staticMethod()`
@@ -353,8 +362,6 @@ Test Case - not including namespace
 
 :php:interface:`LibraryInterface`
 
-:php:interface:`~LibraryName\\LibraryInterface`
-
 :php:func:`LibraryInterface::instanceMethod`
 
 :php:exc:`NamespaceException`
@@ -365,6 +372,28 @@ Test Case - not including namespace
 
 :php:func:`LibraryName\\TemplateTrait::render()`
 
+Test Case - Links with prefix trimming
+--------------------------------------
+
+All of the following links should not be prefixed with a namespace.
+
+:php:interface:`~LibraryName\\LibraryInterface`
+
+:php:class:`~LibraryName\\LibraryClass`
+
+:php:trait:`~LibraryName\\TemplateTrait`
+
+:php:exc:`~LibraryName\\NamespaceException`
+
+All of the following links should not be prefixed with a classname.
+
+:php:func:`~LibraryClass::instanceMethod`
+
+:php:const:`~LibraryClass::TEST_CONST`
+
+:php:attr:`~LibraryClass::$property`
+
+
 Test Case - global access
 -------------------------
 
@@ -378,6 +407,8 @@ Test Case - global access
 
 :php:attr:`LibraryName\\LibraryClass::$property`
 
+:php:attr:`~LibraryName\\LibraryClass::$property` Should not be prefixed with classname.
+
 :php:const:`LibraryName\\LibraryClass::TEST_CONST`
 
 :php:const:`LibraryName\\NS_CONST`