text stringlengths 1 93.6k |
|---|
parent_links.append(
|
f"[{resolved.name}](./{module_name}.html"
|
f"#{member_name})"
|
)
|
if parent_links:
|
parents = ", ".join(parent_links)
|
fp.write(f"**Parents**: {parents}\n\n")
|
if (
|
obj.parent
|
and isinstance(obj.parent, docspec.Class)
|
and isinstance(obj, docspec.Variable)
|
):
|
if obj.value:
|
default = obj.value.replace("\n", "")
|
fp.write(f"**Default**: `{default}`\n\n")
|
def _render_root_level_object(
|
self, fp: TextIO, level: int, obj: docspec.Indirection
|
):
|
self._render_header(fp, level, obj)
|
full_name = "mayim" + obj.target
|
module_name, member_name = full_name.rsplit(".", 1)
|
module = list(docspec_python.load_python_modules([module_name]))[0]
|
item = docspec.get_member(module, member_name)
|
if item and item.docstring:
|
docstring = (
|
html.escape(item.docstring.content)
|
if self.escape_html_in_docstring
|
else item.docstring.content
|
)
|
lines = docstring.splitlines()
|
summary = ""
|
for line in lines:
|
if not line:
|
break
|
summary += f" {line}"
|
fp.write(f"{summary}\n\n")
|
fp.write("```{}\n".format("python" if self.code_lang else ""))
|
fp.write(f"from mayim import {member_name}")
|
fp.write("\n```\n\n")
|
fp.write(f"See [{full_name}](./{module_name}.html#{member_name})\n\n")
|
def _resolve_name(self, obj: docspec.ApiObject) -> str:
|
name = ""
|
if obj.path:
|
for part in obj.path:
|
if part is not self and part.name != obj.name:
|
name += self._resolve_name(part)
|
if not name:
|
return obj.name
|
name = f"{name}.{obj.name}"
|
if isinstance(obj, docspec.Module) and name.startswith("."):
|
name = f"mayim.{name}"
|
return name
|
def _render_toc(self, fp: TextIO, level: int, obj: docspec.ApiObject):
|
if level > self.toc_maxdepth:
|
return
|
title = self._slugify(self._get_title(obj))
|
display = self._escape(obj.name)
|
if not self.add_module_prefix and isinstance(obj, docspec.Module):
|
display = display.split(".")[-1]
|
fp.write(" " * level + "* [{}](#{})\n".format(display, title))
|
level += 1
|
for child in sorted(
|
getattr(obj, "members", []), key=attrgetter("name")
|
):
|
if not isinstance(child, docspec.Indirection):
|
self._render_toc(fp, level, child)
|
@staticmethod
|
def _slugify(text: str) -> str:
|
slug = slugify.sub("-", text.lower())
|
return dedup.sub("-", slug).strip("-")
|
@dataclass
|
class MayimMarkdownReferenceResolver(MarkdownReferenceResolver):
|
def resolve_reference(
|
self,
|
suite: ApiSuite,
|
scope: docspec.ApiObject,
|
ref: str,
|
exclusions: Optional[List[Type[docspec.ApiObject]]] = None,
|
) -> Optional[docspec.ApiObject]:
|
ref_split = ref.split(".")
|
resolved = self._resolve_local_reference(scope, ref_split)
|
if resolved and not self._excluded(resolved, exclusions):
|
return resolved
|
if self.global_:
|
def _recurse(
|
obj: docspec.ApiObject,
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.