Linking to source code
docstr_md.src_href.github.Github
class docstr_md.src_href.github.Github(root) [source]
Compiles a hyperlink for source code stored in a Github repository.
| Parameters: | root : str
Path to the root directory of the source code. e.g. |
|---|---|
| Attributes: | root : str
Set from the |
Examples
from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github
src_href = Github('https://github.com/my-username/my-package/blob/master')
soup = PySoup(path='path/to/file.py', src_href=src_href)
md = compile_md(soup)
md is a string of compiled markdown with source code links in the class
and function headers.
Methods
__call__(self, obj) [source]
Compile the hyperlink for the source code of the input object.
| Parameters: | obj : docstr_md.soup_objects.FunctionDef or ClassDef
Soup object to whose souce code we are linking. |
|---|---|
| Returns: | href : str
Hyperlink of the form |