Create a reference section

Added a reference section to doc

Closes-Bug: #2072354

Change-Id: I586364b118307469b8c3fcefada68df11aa854a6
This commit is contained in:
satoshi-sh 2025-02-05 10:12:53 -06:00
parent e506357313
commit 68f379582d
2 changed files with 31 additions and 0 deletions

View File

@ -99,6 +99,14 @@ Contributor Guide
contributor/index
References
==========
.. toctree::
:maxdepth: 2
references/index
.. only:: html
Indices and tables

View File

@ -0,0 +1,23 @@
==========
References
==========
This section contains reference materials for Ironic, including API documentation, CLI tools, configuration details, and more.
Drivers, Hardware Types, and Hardware Interfaces
------------------------------------------------
:doc:`Drivers, Hardware Types, and Hardware Interfaces </admin/index>`
Configuration Reference
-----------------------
:doc:`Configuration Reference </configuration/index>`
API Reference
-------------
`API Reference <https://docs.openstack.org/api-ref/baremetal/>`_
CLI References
--------------
- `Ironic CLI <https://docs.openstack.org/python-ironicclient/queens/cli/ironic_client.html>`_
- :doc:`ironic-dbsync </cli/ironic-dbsync>`
- `ironic-status <https://docs.openstack.org/python-ironicclient/queens/cli/ironic_client.html>`_