
It seems that the wsme sphinx extension was concealing issues in our doc builds, where formatting was not exactly correct nor parsed as we would always expect as we have had a tendency to fully document data structures as if we are typing code. Upon disabling the extension, the prior build failures due to duplicate labels disappeared and other issues preventing the docs from building successfully were raised. It also seems that we never actually used the extension as documented https://wsme.readthedocs.io/en/latest/document.html $ grep -ir "wsme:root" ./ironic $ grep -ir "wsme:type" ./ironic $ grep -ir "wsme:attribute" ./ironic $ grep -ir "wsme:service" ./ironic $ grep -ir "autotype" ./ironic ./ironic/objects/fields.py:class FlexibleDictField(object_fields.AutoTypedField): ./ironic/objects/fields.py:class MACAddressField(object_fields.AutoTypedField): $ grep -ir "autoattribute" ./ironic $ grep -ir "autoservice" ./ironic $ grep -ir "autofunction" ./ironic $ Co-Authored-By: Dmitry Tantsur <dtantsur@redhat.com> Change-Id: Ib5bbd9274a4098022fba69f0e4998485d2ee2396 Story: 2003020 Task: 23043
Team and repository tags
Ironic
Ironic consists of an API and plug-ins for managing and provisioning physical machines in a security-aware and fault-tolerant manner. It can be used with nova as a hypervisor driver, or standalone service using bifrost. By default, it will use PXE and IPMI to interact with bare metal machines. Ironic also supports vendor-specific plug-ins which may implement additional functionality.
Ironic is distributed under the terms of the Apache License, Version 2.0. The full terms and conditions of this license are detailed in the LICENSE file.
Project resources
- Documentation: https://docs.openstack.org/ironic/latest
- Source: https://git.openstack.org/cgit/openstack/ironic
- Bugs: https://storyboard.openstack.org/#!/project/943
- Wiki: https://wiki.openstack.org/wiki/Ironic
- APIs: https://developer.openstack.org/api-ref/baremetal/index.html
- Release Notes: https://docs.openstack.org/releasenotes/ironic/
Project status, bugs, and requests for feature enhancements (RFEs) are tracked in StoryBoard: https://storyboard.openstack.org/#!/project/943
For information on how to contribute to ironic, see https://docs.openstack.org/ironic/latest/contributor