luke
/
prjxray
mirror of https://github.com/openXC7/prjxray.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

run make format 

Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
This commit is contained in:
Alessandro Comodi 2019-09-02 17:46:16 +02:00
parent 887c5b67a9
commit 78fd7843a5
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/markdown_code_symlinks.py
View File

@ -13,7 +13,6 @@ else:
from urllib.parse import urlparse, unquote from urllib.parse import urlparse, unquote
from recommonmark import parser from recommonmark import parser
""" """
Allow linking of Markdown documentation from the source code tree into the Sphinx Allow linking of Markdown documentation from the source code tree into the Sphinx
documentation tree. documentation tree.
@ -25,6 +24,7 @@ We also want links from two Markdown documents found in the Sphinx docs to
work, so that is also fixed up. work, so that is also fixed up.
""" """
def path_contains(parent_path, child_path): def path_contains(parent_path, child_path):
"""Check a path contains another path. """Check a path contains another path.
@ -166,8 +166,8 @@ Current Value: {}
return filename return filename
# Overriden method to solve the cross-reference link # Overriden method to solve the cross-reference link
def resolve_xref(self, env, fromdocname, builder, def resolve_xref(
typ, target, node, contnode): self, env, fromdocname, builder, typ, target, node, contnode):
if '#' in target: if '#' in target:
todocname, targetid = target.split('#') todocname, targetid = target.split('#')
else: else:
@ -177,16 +177,19 @@ Current Value: {}
# Removing filename extension (e.g. contributing.md -> contributing) # Removing filename extension (e.g. contributing.md -> contributing)
todocname, _ = os.path.splitext(self.mapping['code2docs'][todocname]) todocname, _ = os.path.splitext(self.mapping['code2docs'][todocname])
newnode = make_refnode(builder, fromdocname, todocname, targetid, contnode[0]) newnode = make_refnode(
builder, fromdocname, todocname, targetid, contnode[0])
print(newnode) print(newnode)
return newnode return newnode
def resolve_any_xref(self, env, fromdocname, builder, def resolve_any_xref(
target, node, contnode): self, env, fromdocname, builder, target, node, contnode):
res = self.resolve_xref(env, fromdocname, builder, 'xref', target, node, contnode) res = self.resolve_xref(
env, fromdocname, builder, 'xref', target, node, contnode)
return [('prjxray:xref', res)] return [('prjxray:xref', res)]
class LinkParser(parser.CommonMarkParser, object): class LinkParser(parser.CommonMarkParser, object):
def visit_link(self, mdnode): def visit_link(self, mdnode):
ref_node = nodes.reference() ref_node = nodes.reference()
@ -219,8 +222,7 @@ class LinkParser(parser.CommonMarkParser, object):
reftype='xref', reftype='xref',
refdomain='prjxray', # Added to enable cross-linking refdomain='prjxray', # Added to enable cross-linking
refexplicit=True, refexplicit=True,
refwarn=True refwarn=True)
)
# TODO also not correct sourcepos # TODO also not correct sourcepos
wrap_node.line = self._get_line(mdnode) wrap_node.line = self._get_line(mdnode)
if mdnode.title: if mdnode.title:
@ -231,6 +233,7 @@ class LinkParser(parser.CommonMarkParser, object):
self.current_node.append(next_node) self.current_node.append(next_node)
self.current_node = ref_node self.current_node = ref_node
if __name__ == "__main__": if __name__ == "__main__":
import doctest import doctest
doctest.testmod() doctest.testmod()