diff options
author | Nejc Habjan <hab.nejc@gmail.com> | 2021-12-01 01:04:53 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-01 01:04:53 +0100 |
commit | 8d76826fa64460e504acc5924f859f8dbc246b42 (patch) | |
tree | 083fefada982c795e2415092794db429abb0c184 /docs/ext/docstrings.py | |
parent | 5a1678f43184bd459132102cc13cf8426fe0449d (diff) | |
parent | 86ab04e54ea4175f10053decfad5086cda7aa024 (diff) | |
download | gitlab-master.tar.gz |
Merge pull request #1723 from python-gitlab/jlvillal/dead_mastermaster
Close-out `master` branch
Diffstat (limited to 'docs/ext/docstrings.py')
-rw-r--r-- | docs/ext/docstrings.py | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py deleted file mode 100644 index fc1c10b..0000000 --- a/docs/ext/docstrings.py +++ /dev/null @@ -1,56 +0,0 @@ -import inspect -import os - -import jinja2 -import sphinx -import sphinx.ext.napoleon as napoleon -from sphinx.ext.napoleon.docstring import GoogleDocstring - - -def classref(value, short=True): - return value - - if not inspect.isclass(value): - return ":class:%s" % value - tilde = "~" if short else "" - return ":class:`%sgitlab.objects.%s`" % (tilde, value.__name__) - - -def setup(app): - app.connect("autodoc-process-docstring", _process_docstring) - app.connect("autodoc-skip-member", napoleon._skip_member) - - conf = napoleon.Config._config_values - - for name, (default, rebuild) in conf.items(): - app.add_config_value(name, default, rebuild) - return {"version": sphinx.__display_version__, "parallel_read_safe": True} - - -def _process_docstring(app, what, name, obj, options, lines): - result_lines = lines - docstring = GitlabDocstring(result_lines, app.config, app, what, name, obj, options) - result_lines = docstring.lines() - lines[:] = result_lines[:] - - -class GitlabDocstring(GoogleDocstring): - def _build_doc(self, tmpl, **kwargs): - env = jinja2.Environment( - loader=jinja2.FileSystemLoader(os.path.dirname(__file__)), trim_blocks=False - ) - env.filters["classref"] = classref - template = env.get_template(tmpl) - output = template.render(**kwargs) - - return output.split("\n") - - def __init__( - self, docstring, config=None, app=None, what="", name="", obj=None, options=None - ): - super(GitlabDocstring, self).__init__( - docstring, config, app, what, name, obj, options - ) - - if name.startswith("gitlab.v4.objects") and name.endswith("Manager"): - self._parsed_lines.extend(self._build_doc("manager_tmpl.j2", cls=self._obj)) |