Skip to content

Commit b722e28

Browse files
author
Thomas
committed
Removed new line from doc string. Updated documentation
1 parent 228ee06 commit b722e28

File tree

4 files changed

+51
-20
lines changed

4 files changed

+51
-20
lines changed

Diff for: docs/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Contents
2121

2222
.. toctree::
2323
:maxdepth: 2
24+
:caption: Contents:
2425

26+
netbox
2527
examples
2628

2729

Diff for: docs/netbox.rst renamed to docs/netbox.rst.old

File renamed without changes.

Diff for: docs/source/netbox.rst

+48-18
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,59 @@
11
netbox package
22
==============
33

4-
Submodules
5-
----------
4+
The ``dcim`` class
5+
------------------
66

7-
netbox\.dcim module
8-
-------------------
7+
.. autoclass:: netbox.dcim
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
911

10-
.. automodule:: netbox.dcim
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
12+
The ``extras`` class
13+
--------------------
1414

15-
netbox\.ipam module
16-
-------------------
15+
.. autoclass:: netbox.extras
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
The ``ipam`` class
21+
------------------
22+
23+
.. autoclass:: netbox.ipam
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
The ``netbox`` class
29+
--------------------
30+
31+
.. autoclass:: netbox.netbox
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
The ``tenancy`` class
37+
---------------------
38+
39+
.. autoclass:: netbox.tenancy
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
The ``virtualization`` class
45+
----------------------------
46+
47+
.. autoclass:: netbox.virtualization
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
1751

18-
.. automodule:: netbox.ipam
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
2252

2353
Module contents
2454
---------------
2555

26-
.. automodule:: netbox
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
56+
.. autoclass:: netbox
57+
:members:
58+
:undoc-members:
59+
:show-inheritance:

Diff for: netbox/dcim.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -421,8 +421,7 @@ def create_interface(self, name, interface_type, device_id, **kwargs):
421421
"""Create a new interface
422422
423423
:param name: name of the interface
424-
:param interface_type: interface type. It is not possible to get the list of types from the api. Search
425-
in the netbox code for the correct type number.
424+
:param interface_type: interface type. It is not possible to get the list of types from the api. Search in the netbox code for the correct type number.
426425
:param kwargs: optional arguments
427426
:param device_id: ID of the device to associate interface with
428427
:return: netbox object if successful otherwise raise CreateException

0 commit comments

Comments
 (0)