diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 164 | ||||
-rw-r--r-- | docs/ext/docstrings.py | 41 |
2 files changed, 109 insertions, 96 deletions
diff --git a/docs/conf.py b/docs/conf.py index 4b4a760..a5e5406 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,44 +20,42 @@ import sys import sphinx -sys.path.append('../') +sys.path.append("../") sys.path.append(os.path.dirname(__file__)) import gitlab -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +on_rtd = os.environ.get("READTHEDOCS", None) == "True" # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ - 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'ext.docstrings' -] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "ext.docstrings"] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'python-gitlab' -copyright = '2013-2018, Gauvain Pocentek, Mika Mäenpää' +project = "python-gitlab" +copyright = "2013-2018, Gauvain Pocentek, Mika Mäenpää" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -70,175 +68,179 @@ release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' -if not on_rtd: # only import and set the theme if we're building docs locally +html_theme = "default" +if not on_rtd: # only import and set the theme if we're building docs locally try: import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' + + html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - except ImportError: # Theme not found, use default + except ImportError: # Theme not found, use default pass # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'python-gitlabdoc' +htmlhelp_basename = "python-gitlabdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'python-gitlab.tex', 'python-gitlab Documentation', - 'Gauvain Pocentek, Mika Mäenpää', 'manual'), + ( + "index", + "python-gitlab.tex", + "python-gitlab Documentation", + "Gauvain Pocentek, Mika Mäenpää", + "manual", + ) ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -246,12 +248,17 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'python-gitlab', 'python-gitlab Documentation', - ['Gauvain Pocentek, Mika Mäenpää'], 1) + ( + "index", + "python-gitlab", + "python-gitlab Documentation", + ["Gauvain Pocentek, Mika Mäenpää"], + 1, + ) ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -260,20 +267,25 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'python-gitlab', 'python-gitlab Documentation', - 'Gauvain Pocentek, Mika Mäenpää', 'python-gitlab', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "python-gitlab", + "python-gitlab Documentation", + "Gauvain Pocentek, Mika Mäenpää", + "python-gitlab", + "One line description of project.", + "Miscellaneous", + ) ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - +# texinfo_no_detailmenu = False diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py index 5035f4f..e42bb60 100644 --- a/docs/ext/docstrings.py +++ b/docs/ext/docstrings.py @@ -13,46 +13,47 @@ def classref(value, short=True): return value if not inspect.isclass(value): - return ':class:%s' % value - tilde = '~' if short else '' - string = '%s.%s' % (value.__module__, value.__name__) - return ':class:`%sgitlab.objects.%s`' % (tilde, value.__name__) + return ":class:%s" % value + tilde = "~" if short else "" + string = "%s.%s" % (value.__module__, value.__name__) + 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) + 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 six.iteritems(conf): app.add_config_value(name, default, rebuild) - return {'version': sphinx.__display_version__, 'parallel_read_safe': True} + 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) + 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 + 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') + 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) + 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)) + if name.startswith("gitlab.v4.objects") and name.endswith("Manager"): + self._parsed_lines.extend(self._build_doc("manager_tmpl.j2", cls=self._obj)) |