Merge "Fix broken links in CONTRIBUTING.rst"

CONTRIBUTING.rst

@@ -177,8 +177,8 @@ Writing a Plugin
 
 * **ironic-inspector** allows you to hook code into the data processing chain
   after introspection. Inherit ``ProcessingHook`` class defined in
-  ironic_inspector.plugins.base_ module and overwrite any or both of
-  the following methods:
+  :doc:`/contributor/api/ironic_inspector.plugins.base` and overwrite any or
+  both of the following methods:
 
   ``before_processing(introspection_data,**)``
       called before any data processing, providing the raw data. Each plugin in
@@ -211,9 +211,10 @@ Writing a Plugin
   configuration file (``processing.node_not_found_hook`` option).
 
 * **ironic-inspector**  allows more condition types to be added for
-  `Introspection Rules`_. Inherit ``RuleConditionPlugin`` class defined in
-  ironic_inspector.plugins.base_ module and overwrite at least the following
-  method:
+  :ref:`Introspection Rules <introspection_rules>`.
+  Inherit ``RuleConditionPlugin`` class defined in
+  :doc:`/contributor/api/ironic_inspector.plugins.base` and overwrite at least
+  the following method:
 
   ``check(node_info,field,params,**)``
       called to check that condition holds for a given field. Field value is
@@ -238,10 +239,11 @@ Writing a Plugin
   Make your plugin a setuptools entry point under
   ``ironic_inspector.rules.conditions`` namespace.
 
-* **ironic-inspector** allows more action types to be added for `Introspection
-  Rules`_. Inherit ``RuleActionPlugin`` class defined in
-  ironic_inspector.plugins.base_ module and overwrite at least the following
-  method:
+* **ironic-inspector** allows more action types to be added for
+  :ref:`Introspection Rules <introspection_rules>`.
+  Inherit ``RuleActionPlugin`` class defined in
+  :doc:`/contributor/api/ironic_inspector.plugins.base` and overwrite at least
+  the following method:
 
   ``apply(node_info,params,**)``
       called to apply the action.
@@ -264,15 +266,12 @@ Writing a Plugin
     ``**`` argument is needed so that we can add optional arguments without
     breaking out-of-tree plugins. Please make sure to include and ignore it.
 
-.. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/contributor/api/ironic_inspector.plugins.base.html
-.. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/user/usage.html#introspection-rules
-
 Making changes to the database
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In order to make a change to the ironic-inspector database you must update the
-database models found in ironic_inspector.db_ and then create a migration to
-reflect that change.
+database models found in :doc:`/contributor/api/ironic_inspector.db` and then
+create a migration to reflect that change.
 
 There are two ways to create a migration which are described below, both of
 these generate a new migration file. In this file there is only one function:
@@ -311,7 +310,6 @@ the database::
     ironic-inspector-dbsync revision -m "A short description"
 
 .. _Create a Migration Script: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script
-.. _ironic_inspector.db: https://docs.openstack.org/ironic-inspector/latest/contributor/api/ironic_inspector.db.html
 .. _What does Autogenerate Detect (and what does it not detect?): http://alembic.zzzcomputing.com/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect
 
 Implementing PXE Filter Drivers

doc/source/conf.py

@@ -131,3 +131,4 @@ apidoc_excluded_paths = [
     'test',
     'common/i18n*'
 ]
+apidoc_separate_modules = True