From 68f379582d851827c20c68c3f27381967ae871f5 Mon Sep 17 00:00:00 2001 From: satoshi-sh Date: Wed, 5 Feb 2025 10:12:53 -0600 Subject: [PATCH] Create a reference section Added a reference section to doc Closes-Bug: #2072354 Change-Id: I586364b118307469b8c3fcefada68df11aa854a6 --- doc/source/index.rst | 8 ++++++++ doc/source/references/index.rst | 23 +++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 doc/source/references/index.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 13759b66da..5443b3a0a7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -99,6 +99,14 @@ Contributor Guide contributor/index +References +========== + +.. toctree:: + :maxdepth: 2 + + references/index + .. only:: html Indices and tables diff --git a/doc/source/references/index.rst b/doc/source/references/index.rst new file mode 100644 index 0000000000..76dd2954a9 --- /dev/null +++ b/doc/source/references/index.rst @@ -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 ` + +Configuration Reference +----------------------- +:doc:`Configuration Reference ` + +API Reference +------------- +`API Reference `_ + +CLI References +-------------- +- `Ironic CLI `_ +- :doc:`ironic-dbsync ` +- `ironic-status `_