Commit 9ad4b8f1 authored by Louis's avatar Louis
Browse files

[doc] Plugin descriptions

parent b331a8b8
Pipeline #7485 passed with stage
in 27 seconds
......@@ -6,174 +6,123 @@ TODO
List of plugins
---------------
.. class:: base.Color
Base plugins
^^^^^^^^^^^^
``color``
"""""""""
TODO description
Produce a square of the same color of the corresponding download chart line. Takes no arguments.
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Empty
``TODO base.Empty``
"""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Error
``TODO base.Error``
"""""""""""""""""""
TODO description
``empty``
"""""""""
* Foo (required)
TODO Description
Produce an empty cell. Takes no arguments.
* Bar (default `baz`)
TODO Description
``error``
"""""""""
.. class:: base.Html
Produce a text corresponding to an error (this is used internally). Takes no arguments.
``TODO base.Html``
""""""""""""""""""
``html``
""""""""
TODO description
Copy raw html code.
* Foo (required)
TODO Description
* ``html`` (required)
The raw html code to render.
* Bar (default `baz`)
TODO Description
``link``
""""""""
.. class:: base.Link
Produce a link to an URL.
``TODO base.Link``
""""""""""""""""""
* ``href`` (required)
URL of the ressource to link to.
TODO description
* ``content`` (defaults to the `href` argument)
The text of the link.
* Foo (required)
TODO Description
Gitlab
^^^^^^
* Bar (default `baz`)
TODO Description
``gitlabci``
""""""""""""
.. class:: gitlab.CI
Produce a badge for latest `gitlabCI <//about.gitlab.com/gitlab-ci/>`_ build.
``TODO gitlab.CI``
""""""""""""""""""
* ``server`` (default `http://gitlab.com`)
URL of the gitlab server.
TODO description
* ``user`` (required)
Name of the user owning the package.
* Foo (required)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
* Bar (default `baz`)
TODO Description
Those options, combined, should produce the package URL: ``{server}/{user}/{slug}``.
.. class:: pypi.Homepage
PyPI
^^^^
``TODO pypi.Homepage``
``homepage``
""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
Package home page, retrieved from Pypi metadata.
.. class:: readthedocs.Readthedocs
`Readthedocs <http://readthedocs.io>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``TODO readthedocs.Readthedocs``
""""""""""""""""""""""""""""""""
``readthedocs``
"""""""""""""""
TODO description
`Readthedocs <http://readthedocs.io>` build badge.
* Foo (required)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
* Bar (default `baz`)
TODO Description
* ``branch``
Branch name, if the default branch should not be used.
.. class:: shields.PypiDailyDownloads
* ``lang``
Documentation language, if the default lang should not be used.
``TODO shields.PypiDailyDownloads``
"""""""""""""""""""""""""""""""""""
`Shields <http://shields.io>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiMonthlyDownloads
``TODO shields.PypiMonthlyDownloads``
"""""""""""""""""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiVersion
``TODO shields.PypiVersion``
""""""""""""""""""""""""""""
TODO description
``pypiddownloads``
""""""""""""""""""
* Foo (required)
TODO Description
Badge displaying Pypi daily download statistics.
* Bar (default `baz`)
TODO Description
``pypiwdownloads``
""""""""""""""""""
.. class:: shields.PypiWeeklyDownloads
Badge displaying Pypi weekly download statistics.
``TODO shields.PypiWeeklyDownloads``
""""""""""""""""""""""""""""""""""""
``pypimdownloads``
""""""""""""""""""
TODO description
Badge displaying Pypi monthly download statistics.
* Foo (required)
TODO Description
``pypiversion``
"""""""""""""""
* Bar (default `baz`)
TODO Description
Badge displaying Pypi version.
.. class:: travis.TravisCI
`Travis <http://travis-ci.org/>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``TODO travis.TravisCI``
""""""""""""""""""""""""
``travisci``
""""""""""""
TODO description
`Travis <http://travis-ci.org/>`_ badge.
* Foo (required)
TODO Description
* ``user`` (required)
Travis username.
* Bar (default `baz`)
TODO Description
* ``slug``
Repository name, if different from the pypi package name.
Write your own
......@@ -182,12 +131,16 @@ Write your own
TODO
Raw
"""
^^^
TODO
Jinja2
""""""
^^^^^^
TODO
Default and Required arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment