Commit 07d1cdc5 authored by SIMONIN Matthieu's avatar SIMONIN Matthieu

update doc

parent 6f8897d9
......@@ -34,13 +34,6 @@ EnOSlib has been initially developed in the context of the `Discovery
GPLv3 licence. It's a library written in Python: you are free to import it in
your code and cherry-pick any of its functions.
At a glance
-----------
.. raw:: html
<script id="asciicast-iVBbJPeoWA8botcQXPcNGEac3" src="https://asciinema.org/a/iVBbJPeoWA8botcQXPcNGEac3.js" data-speed="3" async></script>
Links
-----
......
......@@ -54,6 +54,8 @@ Changelog
class citizens. In particular, ``DockerHost`` is a specialization of
``Host``.
- Introduce ``enoslib.local`` to manage the local machine as an EnOSlib host.
- Providers: Any provider can now be used using a context manager. The
resources will be release when leaving the context.
......
......@@ -10,6 +10,13 @@ Base Objects
:members: Network, DefaultNetwork, Host
Local
-----
.. automodule:: enoslib.local
:members: LocalHost
Docker
------
......
......@@ -6,6 +6,13 @@
.. include:: ../README.rst
At a glance
-----------
.. raw:: html
<script id="asciicast-iVBbJPeoWA8botcQXPcNGEac3" src="https://asciinema.org/a/iVBbJPeoWA8botcQXPcNGEac3.js" data-speed="3" async></script>
.. toctree::
:maxdepth: 2
:hidden:
......
......@@ -2,7 +2,12 @@ from .objects import Host
class LocalHost(Host):
"""Representation of your local machine."""
"""Representation of a local machine.
Args:
alias: alias for a local machine
must be unique
"""
def __init__(self, alias: str = "localhost"):
super().__init__(
......
Markdown is supported
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