Esempio n. 1
0
    def _get_rst_header(cls, f):
        name = cls._get_title(f)

        try:
            url = get_doc_url(f)
            doc_link = f'`[doc] <{url}>`_'
        except Exception:
            doc_link = ''

        return textwrap.dedent(f"""
                {name}
                {'=' * len(name)}

                {get_short_doc(f, strip_rst=True)} {doc_link}
            """
        )
Esempio n. 2
0
    def _get_rst_header(f):
        name = f.__name__
        prefix = 'plot_'
        if name.startswith(prefix):
            name = name[len(prefix):]
        name = name.replace('_', ' ').capitalize()

        try:
            url = get_doc_url(f)
            doc_link = f'`[doc] <{url}>`_'
        except Exception:
            doc_link = ''

        return textwrap.dedent(f"""
                {name}
                {'=' * len(name)}

                {get_short_doc(f)} {doc_link}
            """)
Esempio n. 3
0
    def _get_rst_header(f):
        name = f.__name__
        prefix = 'plot_'
        if name.startswith(prefix):
            name = name[len(prefix):]
        name = name.replace('_', ' ').capitalize()

        try:
            url = get_doc_url(f)
            doc_link = '`[doc] <{url}>`_'.format(url=url)
        except Exception:
            doc_link = ''

        return textwrap.dedent("""
                {name}
                {name_underline}

                {docstring} {link}
            """).format(
            name=name,
            link=doc_link,
            name_underline='=' * len(name),
            docstring=get_short_doc(f),
        )