Browse Source

Introducing the contributor content

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

Change-Id: I111cd55a06e40dc4db649728a5025354a85b3e1d
Partial-Bug: 1702142
changes/22/480222/6
dparalen 5 years ago
parent
commit
cc7b98aa10
  1. 5
      .gitignore
  2. 2
      CONTRIBUTING.rst
  3. 3
      doc/source/contributing.rst
  4. 11
      doc/source/contributor/index.rst
  5. 16
      doc/source/index.rst
  6. 1
      setup.cfg

5
.gitignore vendored

@ -6,7 +6,7 @@
# Sphinx
_build
#doc/source/api/
doc/source/contributor/api/
# release notes build
releasenotes/build
@ -39,5 +39,4 @@ ChangeLog
*~
# Vagrant
.vagrant
doc/source/api/
.vagrant

2
CONTRIBUTING.rst

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

3
doc/source/contributing.rst

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

11
doc/source/contributor/index.rst

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

16
doc/source/index.rst

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

1
setup.cfg

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

Loading…
Cancel
Save