Commit e2dffa74 authored by Louis's avatar Louis
Browse files

[doc] Draft of documentation

parent 5851e7d6
Pipeline #7478 passed with stage
in 27 seconds
......@@ -11,9 +11,10 @@ continuous integration, etc.). See the example below.
|example|
It is available as a `command line interface
<//pypimonitor.readthedocs.io/TODO>`_ that generates the HTML code, and as a
`web server <//pypimonitor.readthedocs.io/TODO>`_, to generate and serve this
dashboard.
<//pypimonitor.readthedocs.io/en/latest/module.html#pypimonitor-httpd>`_ that
generates the HTML code, and as a `web server
<//pypimonitor.readthedocs.io/en/latest/module.html#pypimonitor-httpd>`_, to
generate and serve this dashboard.
What's new?
-----------
......
......@@ -8,17 +8,16 @@ Welcome to PypiMonitor's documentation!
TODO
|example|
.. |example| image:: _static/spalax.png
:target: _static/spalax.html
Contents:
.. toctree::
:maxdepth: 2
module
yaml
plugins
|example|
Indices and tables
==================
......@@ -27,3 +26,5 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
.. |example| image:: _static/spalax.png
:target: _static/spalax.html
Modules
=======
TODO
.. module:: pypimonitor
``pypimonitor``
---------------
TODO
.. module:: pypimonitor.httpd
``pypimonitor.httpd``
---------------
TODO
Cell plugins
============
TODO
List of plugins
---------------
.. class:: base.Color
``color``
"""""""""
TODO description
* 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
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Html
``TODO base.Html``
""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: base.Link
``TODO base.Link``
""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: gitlab.CI
``TODO gitlab.CI``
""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: pypi.Homepage
``TODO pypi.Homepage``
""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: readthedocs.Readthedocs
``TODO readthedocs.Readthedocs``
""""""""""""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiDailyDownloads
``TODO shields.PypiDailyDownloads``
"""""""""""""""""""""""""""""""""""
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
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: shields.PypiWeeklyDownloads
``TODO shields.PypiWeeklyDownloads``
""""""""""""""""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
.. class:: travis.TravisCI
``TODO travis.TravisCI``
""""""""""""""""""""""""
TODO description
* Foo (required)
TODO Description
* Bar (default `baz`)
TODO Description
Write your own
--------------
TODO
Raw
"""
TODO
Jinja2
""""""
TODO
YAML configuration files
========================
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