This change documents the types and attributes used by the TripleO
networking templates[1] along with how these are used by the ifcfg
backend.
The next change in this series will be a new page of complex examples
to illustrate the usage of these types and attributes.
Future changes can document unused types and attributes, and also add
ENI backend notes to go alongside the ifcfg notes.
[1] https://opendev.org/openstack/tripleo-ansible/src/branch/master/tripleo_ansible/roles/tripleo_network_config/templates
Change-Id: Ic9d5643354b76165261498d875266c68e9bc6a7e
Change-Id: Iff3cdb2657b3e427f9fa3a882479253bf2e27fee
As part of an effort to fully document os-net-config, this change
makes the README.rst more consistent with other projects, and expands
the usage.rst page to describe useful command-line arguments.
Now that the README has a link to the generated documentation[1], the
provider section can be replaced by the one in the usage.rst page.
[1] https://docs.openstack.org/os-net-config/latest/
Change-Id: I065da7c7028bf081fb1d87ef64c4f3f873bfe111
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I13e5de067ad381d058060bc5e297a0360804e119
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Cleanup releasenotes/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme and Sphinx versions
- Remove install_command from tox.ini, the default is fine
- Update to hacking 3.0 for Sphinx 3 support, fix problems found
Change-Id: Id7cab423584af9280da54f12a29daa1f60a3ca35
Use doc/requirements for documentation requirements, this avoids pulling
in sphinx into the python environments and thus solves the problem that triggered
https://review.opendev.org/658224 as well.
Note that both changes are needed in general, while the problem is solved
with either.
Switch to openstackdocstheme instead of oslosphinx, update sphinx
requirements for this and sync with global requirements.
Change-Id: I360c185af8740a71ebc0f5f49debd5b6032161ec
Ghanshyam Mann