Skip to content

Commit 3bc4c8a

Browse files
authored
Fix documentation toolchain (#82)
* Add intersphinx mappings to link to external docs too * explicitly set language to * Regenerate documentation * Add changelog
1 parent e9feb9a commit 3bc4c8a

14 files changed

+6757
-2974
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
bugfixes:
2+
- Fix documentation toolchain to link to external content automatically

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
#
6666
# This is also used if you do content translation via gettext catalogs.
6767
# Usually you set "language" from the command line for these cases.
68-
language = None
68+
language = 'en'
6969

7070
# List of patterns, relative to source directory, that match files and
7171
# directories to ignore when looking for source files.
@@ -181,3 +181,4 @@
181181

182182

183183
# -- Extension configuration -------------------------------------------------
184+
intersphinx_mapping = {'python': ('https://docs.python.org/2', None), 'ansible': ('https://docs.ansible.com/ansible/latest/', None)}

docs/plugins/address_module.rst

Lines changed: 818 additions & 358 deletions
Large diffs are not rendered by default.

docs/plugins/device_module.rst

Lines changed: 964 additions & 422 deletions
Large diffs are not rendered by default.

docs/plugins/device_type_module.rst

Lines changed: 338 additions & 146 deletions
Large diffs are not rendered by default.

docs/plugins/domain_module.rst

Lines changed: 372 additions & 161 deletions
Large diffs are not rendered by default.

docs/plugins/index.rst

Lines changed: 43 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,66 @@
11

2+
3+
24
.. _plugins_in_codeaffen.phpipam:
35

46
Codeaffen.Phpipam
57
=================
68

79
Collection version 1.5.0
810

11+
.. contents::
12+
:local:
13+
:depth: 1
14+
15+
Description
16+
-----------
17+
18+
Ansible Modules to manage phpIPAM installations
19+
20+
**Authors:**
21+
22+
* Andreas Klamke <[email protected]>
23+
* Billy Longman <[email protected]>
24+
* Christian Meißner <[email protected]>
25+
* Gerald-Markus Zabos <[email protected]>
26+
* Mario Fritschen <[email protected]>
27+
* Scott Arthur <[email protected]>
28+
29+
30+
.. raw:: html
31+
32+
<p class="ansible-links">
33+
<a href="https://github.com/codeaffen/phpipam-ansible-modules/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
34+
<a href="https://codeaffen.org/projects/phpipam-ansible-modules" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
35+
<a href="https://github.com/codeaffen/phpipam-ansible-modules" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
36+
</p>
37+
38+
39+
940
.. toctree::
1041
:maxdepth: 1
1142

1243

1344
Plugin Index
1445
------------
1546

16-
These are the plugins in the codeaffen.phpipam collection
17-
18-
19-
Lookup Plugins
20-
~~~~~~~~~~~~~~
47+
These are the plugins in the codeaffen.phpipam collection:
2148

22-
* :ref:`subnet <ansible_collections.codeaffen.phpipam.subnet_lookup>` -- lookup for subnet information
2349

2450
Modules
2551
~~~~~~~
2652

27-
* :ref:`address <ansible_collections.codeaffen.phpipam.address_module>` -- Manage addresses
28-
* :ref:`device <ansible_collections.codeaffen.phpipam.device_module>` -- Manage devices
29-
* :ref:`device_type <ansible_collections.codeaffen.phpipam.device_type_module>` -- Manage device types
30-
* :ref:`domain <ansible_collections.codeaffen.phpipam.domain_module>` -- Manage L2 routing domains
31-
* :ref:`location <ansible_collections.codeaffen.phpipam.location_module>` -- Manage locations
32-
* :ref:`nameserver <ansible_collections.codeaffen.phpipam.nameserver_module>` -- Manage nameservers
33-
* :ref:`section <ansible_collections.codeaffen.phpipam.section_module>` -- Manage sections
34-
* :ref:`subnet <ansible_collections.codeaffen.phpipam.subnet_module>` -- Manage subnets
35-
* :ref:`tag <ansible_collections.codeaffen.phpipam.tag_module>` -- Manage tags
36-
* :ref:`vlan <ansible_collections.codeaffen.phpipam.vlan_module>` -- Manage vlans
37-
* :ref:`vrf <ansible_collections.codeaffen.phpipam.vrf_module>` -- Manage virtual routers and forwarders
53+
* :ref:`address module <ansible_collections.codeaffen.phpipam.address_module>` -- Manage addresses
54+
* :ref:`device module <ansible_collections.codeaffen.phpipam.device_module>` -- Manage devices
55+
* :ref:`device_type module <ansible_collections.codeaffen.phpipam.device_type_module>` -- Manage device types
56+
* :ref:`domain module <ansible_collections.codeaffen.phpipam.domain_module>` -- Manage L2 routing domains
57+
* :ref:`location module <ansible_collections.codeaffen.phpipam.location_module>` -- Manage locations
58+
* :ref:`nameserver module <ansible_collections.codeaffen.phpipam.nameserver_module>` -- Manage nameservers
59+
* :ref:`section module <ansible_collections.codeaffen.phpipam.section_module>` -- Manage sections
60+
* :ref:`subnet module <ansible_collections.codeaffen.phpipam.subnet_module>` -- Manage subnets
61+
* :ref:`tag module <ansible_collections.codeaffen.phpipam.tag_module>` -- Manage tags
62+
* :ref:`vlan module <ansible_collections.codeaffen.phpipam.vlan_module>` -- Manage vlans
63+
* :ref:`vrf module <ansible_collections.codeaffen.phpipam.vrf_module>` -- Manage virtual routers and forwarders
3864

3965

4066

@@ -46,7 +72,6 @@ Modules
4672
:maxdepth: 1
4773
:hidden:
4874

49-
subnet_lookup
5075
address_module
5176
device_module
5277
device_type_module

docs/plugins/location_module.rst

Lines changed: 501 additions & 220 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)