Introducing the contributor content

Moving the contributor "link" and API down the mandatory directory
structure.

Change-Id: I111cd55a06e40dc4db649728a5025354a85b3e1d
Partial-Bug: 1702142
This commit is contained in:
dparalen 2017-07-04 16:54:26 +02:00
parent aa5ad2ec16
commit cc7b98aa10
6 changed files with 19 additions and 19 deletions

3
.gitignore vendored
View File

@ -6,7 +6,7 @@
# Sphinx # Sphinx
_build _build
#doc/source/api/ doc/source/contributor/api/
# release notes build # release notes build
releasenotes/build releasenotes/build
@ -40,4 +40,3 @@ ChangeLog
# Vagrant # Vagrant
.vagrant .vagrant
doc/source/api/

View File

@ -107,7 +107,7 @@ enable both the **ironic** and the **ironic-inspector**. You can start with the
Example local.conf Example local.conf
------------------ ------------------
.. literalinclude:: ../../devstack/example.local.conf .. literalinclude:: ../../../devstack/example.local.conf
Notes Notes

View File

@ -1,3 +0,0 @@
.. _contributing_link:
.. include:: ../../CONTRIBUTING.rst

View File

@ -0,0 +1,11 @@
.. _contributing_link:
.. include:: ../../../CONTRIBUTING.rst
Python API
~~~~~~~~~~
.. toctree::
:maxdepth: 1
api/autoindex

View File

@ -20,21 +20,13 @@ Admin Guide
Installation <install> Installation <install>
Upgrade <upgrade> Upgrade <upgrade>
Developer Guide Contributor
=============== ===========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Contributing <contributing> contributor/index
Python API
----------
.. toctree::
:maxdepth: 1
api/autoindex
Indices and tables Indices and tables
================== ==================

View File

@ -98,3 +98,4 @@ autodoc_exclude_modules =
ironic_inspector.migrations.* ironic_inspector.migrations.*
ironic_inspector.test.* ironic_inspector.test.*
ironic.common.i18n ironic.common.i18n
api_doc_dir = contributor/api