All strings are considered as unicode literal string from Python 3.
This patch drops the explicit unicode literal (u'...')
appearances from the unicode strings.
Change-Id: I52ae9180344baf408e6e8a932e9d59dc45ece9de
Create a new Sphinx extension called 'web_api_docstring' to process
docstrings from the API classes, in order to generate API
documentation.
Story: 2009785
Task: 44291
Change-Id: Ia6b2b3741e2b1cbd29531c21795df4f0f0dc70ca
The header for the file types.py denotes its dual-licensed status as
MIT with copyright to the original WSME authors, plus apache licensed
as part of Ironic.
Story: 1651346
Task: 10551
Change-Id: I986cc4a936c8679e932463ff3c91d1876a713196
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Set openstackdocs_pdf_link to link to PDF file.
Set openstackdocs_auto_name to use 'project' as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I76a21521eeb432c3f4089048a4635719ba6d785c
Adds documentation surrounding the use of multi-tenancy. The
documentation explains possible updates to the policy file
to expose node APIs to a non-admin.
Change-Id: Ib1c327156acee8d34be74dd15c3d4003f7ef31df
The new version enables a lot of standard flake8 checks. Some of them
are temporary disabled to reduce the scope of this patch:
* Complexity check requires a few functions to be rewritten (apparently,
it was not enabled previously).
* Indentation check failures are numerous and potentially contradictive.
These checks will be enabled in follow-ups.
W606 is removed from excludes since we no longer hit it.
Change-Id: I1e5a6f8e5e90c55cfc6f740b26c30196512d3be3
* Remove doc/source/install/conf.py, it's unused.
* Remove settings that are provided by openstackdocstheme from conf.py
files. Switch to newer openstackdocstheme for this.
* Remove unused deps from tox.ini: releasenotes and api-refonly need
doc/requirements but not requirements.
Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
The documentation currently has no information at all about what steps
are available *generally* for automated or manual cleaning. Users who
want to find this information must review the source code themselves,
except in one or two cases where driver-specific documentation has the
details spelled out.
This patch adds a series of tables to the general cleaning
documentation to provide details about the steps one could possibly
add to the instructions given to ironic, along with details about
required parameters and what the effect of each step will be.
Change-Id: I6b225cce38b815248c457814508531041c437e6d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I308c3296bc56fdb623a9fc6b021c388be2d33330
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
We now use the project openstack/ironic-tempest-plugin to store our
tempest plugin. All content from the ironic_tempest_plugin/ directory
has been ported to that project.
We no longer want to have the plugin content stored here so we delete
it.
Remove check in tools/flake8wrap.sh that prevented changes to the
ironic_tempest_plugin/ directory.
Change-Id: I700bd7b71472fa91f6bc02aebc055584df08e0ef
this patch pulls the ansible deploy interface code
and related ansible playbooks and auxiliary files
from ironic-staging-drivers project into main ironic tree.
As discussed in the spec, the use of ramdisk callbacks
(lookup and hearbeats) is now mandatory with this deploy interface.
Playbooks and modules were updated to require Ansible>=2.4,
and custom Ansible module for executing 'parted' was replaced
with usage of built-in Ansible module.
The custom Ansible callback plugin now uses journald logger
by default to adapt to the default DevStack setup.
Documentation and devstack plugin changes enabling automated
testing of this interface will be proposed in followup patches.
Change-Id: I43f54688287953ccb1c2836437aea76236e6560b
Related-Bug: #1526308
Add more details about the node deployment process, when an instance
is booted by nova. This change covers iscsi and direct deploy methods
with PXE boot. This change also updates the sequence diagrams for
deploy process.
Co-Authored-By: Galyna Zholtkevych <galynazholtkevych1991@gmail.com>
Change-Id: Icaec14d10e702627bab0763e40efa77131564dec
Documentation layout aligned with the OS standards.
The admin page cleaned up - unrelated references moved
elsewhere linking merely admin pages.
The configuration page refactored, ironic.conf
and policy.conf documentation and samples
automatically generated by oslo_config.sphinxext.
Change-Id: I9075e2688f59ecd8ab5c489679f2c53d6294f28d
This patch does the following:
* Adds a configuration folder to contain automated generated config
files for Ironic.
* Adds `oslo_config.sphinxconfiggen` to the extensions list.
* Adds `oslo_policy.sphinxpolicygen` to the extensions list.
* Adds ironic-policy-generator.conf
This is important for Ironic to be included in the list of services
on https://docs.openstack.org/pike/configuration/
Change-Id: I51a7204ce00be2588e427c1951e8be7dc7a22647
Closes-bug: #1706176
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.
Fix problems found:
* Duplicate labels (rename wrong faq entries, rename unused drivers
entries)
* Add api/autoindex.rst as hidden to the index so that we do not get a
warning. The modindex includes the same content, so no need to show
this.
* Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst
to hidden index since they're not listed in index on purpose, so sphinx
will not warn that they do not appear in a toc
* Add deploy/radosgw to index
* ignore app.add_directiv warning
* Fix reference to user-guide to use proper markup so that Sphinx knows
the user-guide is referenced.
Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
We don't have tempest in our {test-}requirements.txt, which causes
docs build to complain about missing tempest.* modules, as we have
autodoc enabled, which imports all the modules it can find to get
their docstrings.
This change adds ironic_tempest_plugin modules to
autodoc_exclude_modules, and also adds it to exclude_patterns, so
that sphinx ignores ironic_tempest_plugin/* files too.
Also fixes a couple of warnings because of the incorrect formatting
of the LocalLinkConnectionType.validate docstring.
Closes-bug: #1609850
Change-Id: Id24e587b690b423e65dad55e70224426873e8d5d
In the sphinx config, mock out the nova imports we do for the
compute manager so the docs will build with fewer errors.
Exclude the alembic migration environment from autodoc.
Fix the remaining markup errors, which are now easier to spot
given the other fixes.
Note that this leaves one remaining warning, which is that the
generated API documentation isn't currently included in a
toctree. This is easy to fix but it would be good to discuss
whether/where to include it in the documentation hierarchy.
Closes-Bug: 1277282
Change-Id: Iee5fc3eeb95a09198d5234d0ea05e150ab26f16b
Add sequence diagrams generated by sphinxcontrib-seqdiag
along with the raw text that generated then, so that it can be
updated easily later.
The diagrams were created originally by Devananda van der Veen,
and used in OpenStack Summit YVR.
Ref)
* https://www.openstack.org/summit/vancouver-2015/summit-videos
/presentation/isn-and-039t-it-ironic-the-bare-metal-cloud
* http://devananda.github.io/talks/isnt-it-ironic.html
Change-Id: I47ff02c6cb4764c1740d0924668714ed205b3d9b
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
v1 API doc samples include XML:
http://docs.openstack.org/developer/ironic/webapi/v1.html
However, the Ironic API does not support XML.
This removes the XML documentation from the generated docs.
Change-Id: I0588709190eafa52a252d19a163dc42c36f2e061
Closes-Bug: #1311268
Use the new oslosphinx version of the OpenStack doc theme instead of
maintaining a copy of it in the Ironic repository.
Change-Id: I1d949d1e2734b10e38dea0067db9f3cfd7109c11
Correct the version string in setup.cfg for Icehouse.
Make ironic/version.py use PBR instead of the stale code that was there.
Make ironic/common/config.py properly set the version string so that
all CLI commands output it when "--version" is passed.
Remove openstack.common.version module which is no longer present in
oslo-incubator.
Closes-bug: #1294389
Change-Id: I9a7bfe5fc1b79934cf2467d6f8a6c16f41205dbf
Add the necessary bits for sphinxcontrib-pecanwsme
so that we can start auto-generating REST API docs.
Change-Id: I6ad61a5185462916865884dd1619465ef90aba0a
Closes-bug: 1251011
Some files still use trademark OpenStack LLC in header, which
should be changed to OpenStack Foundation.
Change-Id: I6ab820e61514c6004247d9b931976e03baf84ae0
Fixes-Bug: #1214176
Create doc/source/dev/ directory, and add several files that got
accidentaly ignored because they were under doc/source/api/.
Also move some files from doc/source into doc/source/dev to clean up the
base doc dir.
Change-Id: Ief9777216db82ec3be32b7a73e2d268a3a973ef8
Also turn on doc API autoindexing.
This depends on https://review.openstack.org/30520 landing in pbr and a
new point release being cut, as it uncovered a bug.
Change-Id: I8f4ffc4f7c54c7b207d6d52e74ccab020596e602
