Skip to content

GitLab

P
python-distem
Verified Commit 0bb6bba3 authored by SIMONIN Matthieu's avatar SIMONIN Matthieu
Browse files
Options

Factorize the link to the resource description

parent 66380eaf
Pipeline #88309 passed with stages
        in 2 minutes and 50 seconds
        Hide whitespace changes
        Inline Side-by-side
        Showing with 39 additions and 32 deletions
        distem/__init__.py
        View file @ 0bb6bba3
        ......@@ -20,8 +20,8 @@ class Distem:
        options(dict) used to store vxlan_id and number of PNODES (should not be used directly)
        Returns:
        {Dictionnary} The virtual network description
        see {file:files/resources_desc.md#Virtual_Networks Resource Description - VNetworks}
        {dict} The virtual network description
        see :desc:`resources description <>`.
        """
        if opts is None:
        opts = []
        ......@@ -39,7 +39,7 @@ class Distem:
        vnetname(str) The name of the virtual network
        Returns:
        {Dictionnary} The virtual network description
        {dict} The virtual network description
        see {file:files/resources_desc.md#Virtual_Networks Resource Description - VNetworks}
        """
        ......@@ -56,7 +56,7 @@ class Distem:
        vnetname(str) The name of the virtual network
        Returns:
        {Dictionnary} The virtual network description
        {dict} The virtual network description
        see {file:files/resources_desc.md#Virtual_Networks Resource Description - VNetworks}
        """
        ......@@ -71,7 +71,7 @@ class Distem:
        vnodename(str) The name of the virtual node
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        return self.get_json("/vnodes/%s" % (str(vnodename)))
        ......@@ -92,7 +92,7 @@ class Distem:
        SSH user (see {Distem::Daemon::Admin#SSH_USER} and
        Distem::Node::Container::SSH_KEY_FILENAME)
        _Format_: Dictionnary.
        _Format_: dict.
        _Structure_:
        {
        ......@@ -104,7 +104,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -135,7 +135,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -162,7 +162,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -181,7 +181,7 @@ class Distem:
        vnodename(str) The name of the virtual node
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -199,7 +199,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -219,7 +219,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual node description
        {dict} The virtual node description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -327,7 +327,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The virtual nodes description
        {dict} The virtual nodes description
        see {file:files/resources_desc.md#Virtual_Nodes Resource Description - VNodes}
        """
        ......@@ -347,7 +347,7 @@ class Distem:
        to know when node is configured (see {#vnode_info})
        Returns:
        {Dictionnary} The description of the virtual nodes
        {dict} The description of the virtual nodes
        """
        if names is None:
        ......@@ -414,7 +414,7 @@ class Distem:
        command(str) The command to be executed
        Returns:
        {Dictionnary} The result of the command (one entry by vnode)
        {dict} The result of the command (one entry by vnode)
        """
        return self.post_json("/commands", {"names": names, "command": command})
        ......@@ -429,7 +429,7 @@ class Distem:
        vnodename(str) The name of the virtual node
        Returns:
        {Dictionnary} The virtual node filesystem informations
        {dict} The virtual node filesystem informations
        """
        return self.get_json("/vnodes/%s/filesystem/" % (str(vnodename)))
        ......@@ -446,7 +446,7 @@ class Distem:
        {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}.
        Returns:
        {Dictionnary} The virtual Filesystem description
        {dict} The virtual Filesystem description
        see {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}
        """
        ......@@ -466,7 +466,7 @@ class Distem:
        {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}.
        Returns:
        {Dictionnary} The virtual Filesystem description
        {dict} The virtual Filesystem description
        see {file:files/resources_desc.md#File_System0 Resource Description - VFilesystem}
        """
        ......@@ -483,7 +483,7 @@ class Distem:
        vifacename(str) The name of the virtual network interface
        Returns:
        {Dictionnary} The virtual network interface description
        {dict} The virtual network interface description
        see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
        """
        ......@@ -503,7 +503,7 @@ class Distem:
        {file:files/resources_desc.md#Network_interface Resource Description - VIface}.
        Returns:
        {Dictionnary} The virtual network interface description
        {dict} The virtual network interface description
        see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
        """
        ......@@ -522,7 +522,7 @@ class Distem:
        vifacename(str) The name of the network virtual interface
        Returns:
        {Dictionnary} The virtual network interface description
        {dict} The virtual network interface description
        see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
        """
        ......@@ -546,7 +546,7 @@ class Distem:
        {file:files/resources_desc.md#Network_interface Resource Description - VIface}.
        Returns:
        {Dictionnary} The virtual network interface description
        {dict} The virtual network interface description
        see {file:files/resources_desc.md#Network_Interfaces Resource Description - VIfaces}
        """
        ......@@ -572,7 +572,7 @@ class Distem:
        (need to have enough free ones on the physical node)
        Returns:
        {Dictionnary} The virtual CPU description
        {dict} The virtual CPU description
        see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
        """
        ......@@ -592,7 +592,7 @@ class Distem:
        unit(str) Tell if val is a frequency or a ratio (allowed values are mhz and ration)
        Returns:
        {Dictionnary} The virtual CPU description
        {dict} The virtual CPU description
        see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
        """
        ......@@ -609,7 +609,7 @@ class Distem:
        vnodename(str) The name of the virtual node
        Returns:
        {Dictionnary} The virtual CPU description
        {dict} The virtual CPU description
        see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
        """
        ......@@ -622,7 +622,7 @@ class Distem:
        Returns:
        {Dictionnary} The virtual CPU description
        {dict} The virtual CPU description
        see {file:files/resources_desc.md#CPU0 Resource Description - VCPU}
        """
        ......@@ -643,7 +643,7 @@ class Distem:
        {file:files/resources_desc.md#Virtual_Traffic Resource Description - VTraffic}.
        Returns:
        {Dictionnary} The virtual traffic description
        {dict} The virtual traffic description
        see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
        """
        ......@@ -665,7 +665,7 @@ class Distem:
        vifacename(str) The name of the virtual network interface
        Returns:
        {Dictionnary} The virtual traffic description
        {dict} The virtual traffic description
        see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
        """
        ......@@ -686,7 +686,7 @@ class Distem:
        {file:files/resources_desc.md#Virtual_Traffic Resource Description - VTraffic}.
        Returns:
        {Dictionnary} The virtual traffic description
        {dict} The virtual traffic description
        see {file:files/resources_desc.md#Traffic Resource Description - VTraffic}
        """
        ......@@ -708,7 +708,7 @@ class Distem:
        vifacename(str) The name of the virtual network interface
        Returns:
        {Dictionnary} The virtual traffic description
        {dict} The virtual traffic description
        see {file:files/resources_desc.md#Traffic Resource Description - VTraffic})
        """
        ......@@ -726,7 +726,7 @@ class Distem:
        hierarchy(str) The hierarchy where memory controller is mounted (default to v1)
        Returns:
        {Dictionnary} The memory limitation
        {dict} The memory limitation
        """
        if swap is None:
        ......
        docs/conf.py
        View file @ 0bb6bba3
        ......@@ -32,7 +32,7 @@ sys.path.insert(0, os.path.abspath('..'))
        # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
        # ones.
        #extensions = []
        extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
        extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.extlinks']
        # Add any paths that contain templates here, relative to this directory.
        templates_path = ['_templates']
        ......@@ -174,3 +174,10 @@ texinfo_documents = [
        # Document also the __init__
        autoclass_content = "both"
        rst_epilog = """
        .. |enoslib| replace:: `EnOSlib <https://google.fr>`_
        """
        extlinks = {
        'desc': ('http://distem.gforge.inria.fr/doc/file.resources_desc.html#%s', '')
        }
        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