Added feature for user override of url line anchor notation (#74)

Author: ltan10

README.md

@@ -171,6 +171,7 @@ lazydocs [OPTIONS] PATHS...
 
 * `--output-path TEXT`: The output path for the creation of the markdown files. Set this to `stdout` to print all markdown to stdout.  [default: ./docs/]
 * `--src-base-url TEXT`: The base repo link used as prefix for all source links. Should also include the branch name.
+* `--url-line-prefix TEXT`: Line prefix for git repository line url anchors #{prefix}line. If None provided, defaults to Github style notation.
 * `--overview-file TEXT`: Filename of overview file. If not provided, no API overview file will be generated.
 * `--remove-package-prefix / --no-remove-package-prefix`: If `True`, the package prefix will be removed from all functions and methods.  [default: True]
 * `--ignored-modules TEXT`: A list of modules that should be ignored.  [default: ]

src/lazydocs/_cli.py

@@ -54,6 +54,10 @@ def generate(
         False,
         help="Include table of contents in module file. Defaults to False.",
     ),
+    url_line_prefix: Optional[str] = typer.Option(
+        None,
+        help="Line prefix for git repository line url anchors #{prefix}line. If none provided, defaults to Github style notation.",
+    ),
 ) -> None:
     """Generates markdown documentation for your Python project based on Google-style docstrings."""
 
@@ -70,6 +74,7 @@ def generate(
             validate=validate,
             private_modules=private_modules,
             include_toc=toc,
+            url_line_prefix=url_line_prefix,
         )
     except Exception as ex:
         typer.echo(str(ex))

src/lazydocs/generation.py

@@ -624,6 +624,7 @@ def __init__(
         src_root_path: Optional[str] = None,
         src_base_url: Optional[str] = None,
         remove_package_prefix: bool = False,
+        url_line_prefix: Optional[str] = None,
     ):
         """Initializes the markdown API generator.
 
@@ -632,10 +633,12 @@ def __init__(
             src_base_url: The base github link. Should include branch name.
                 All source links are generated with this prefix.
             remove_package_prefix: If `True`, the package prefix will be removed from all functions and methods.
+            url_line_prefix: Line prefix for git repository line url anchors. Default: None - github "L".
         """
         self.src_root_path = src_root_path
         self.src_base_url = src_base_url
         self.remove_package_prefix = remove_package_prefix
+        self.url_line_prefix = url_line_prefix
 
         self.generated_objects: List[Dict] = []
 
@@ -677,7 +680,13 @@ def _get_src_path(self, obj: Any, append_base: bool = True) -> str:
         relative_path = os.path.relpath(path, src_root_path)
 
         lineno = _get_line_no(obj)
-        lineno_hashtag = "" if lineno is None else "#L{}".format(lineno)
+        if self.url_line_prefix is None:
+            lineno_hashtag = "" if lineno is None else "#L{}".format(lineno)
+        else:
+            lineno_hashtag = "" if lineno is None else "#{}{}".format(
+                self.url_line_prefix,
+                lineno
+            )
 
         # add line hash
         relative_path = relative_path + lineno_hashtag
@@ -1118,6 +1127,7 @@ def generate_docs(
     validate: bool = False,
     private_modules: bool = False,
     include_toc: bool = False,
+    url_line_prefix: Optional[str] = None,
 ) -> None:
     """Generates markdown documentation for provided paths based on Google-style docstrings.
 
@@ -1133,6 +1143,7 @@ def generate_docs(
         watermark: If `True`, add a watermark with a timestamp to bottom of the markdown files.
         validate: If `True`, validate the docstrings via pydocstyle. Requires pydocstyle to be installed.
         private_modules: If `True`, includes modules with `_` prefix.
+        url_line_prefix: Line prefix for git repository line url anchors. Default: None - github "L".
     """
     stdout_mode = output_path.lower() == "stdout"
 
@@ -1173,6 +1184,7 @@ def generate_docs(
         src_root_path=src_root_path,
         src_base_url=src_base_url,
         remove_package_prefix=remove_package_prefix,
+        url_line_prefix=url_line_prefix,
     )
 
     pydocstyle_cmd = "pydocstyle --convention=google --add-ignore=D100,D101,D102,D103,D104,D105,D107,D202"