Commit Graph

12 Commits

Author SHA1 Message Date
Andreas Jaeger ca17ce253c Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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: Ifc57df7591d861508e761b8accc56efd32d762bc
2020-05-24 15:15:05 +02:00
Andreas Jaeger 3de1d4cec1 Cleanup py27 support
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Require newer pbr
- Remove install_command, the default is fine

Change-Id: I975a7012c42b8ee2c30d3a33fc63a083738d8007
2020-04-08 11:50:56 +02:00
Iury Gregory Melo Ferreira 7d8e9cdacc Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

ironic-specs is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal - https://review.opendev.org/#/c/691178/

The only reference for py27 is on requirements.

Change-Id: I40148862c8ee7a0028266b08006b877d57298ac2
2019-11-22 14:56:12 +01:00
Kaifeng Wang d04b5f6d80 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Iade8e60f5e272d70b2bbfdcd8429a19e1f95f365
2019-09-05 11:42:30 +08:00
Riccardo Pittau cc960170a0 Update sphinx requirements
Following recent changes to global requirements [1], we need
to update sphinx requirements locally.

[1] If558f184c959e4b63b56dec3ca1571d1034cfe5c

Change-Id: I64c67c8da327a44e73e30e95ba9a7dae4fb5b6fb
2019-05-23 10:37:15 +02:00
John L. Villalovos 06514c2b79 Switch tox unit test command to use ostestr
This commit switches the tox command to use ostestr instead of calling
testr through setup.py. The primary advantage here is that it uses the
subunit-trace output filter. ostestr primarily exists as a replacement
for pretty_tox.sh bash scripts which spread like a plague through
OpenStack projects after Nova copied it from Tempest. (although
ostestr also provides some other useful features) Granted ironic-specs
wasn't using that, but this commit makes the switch to enable getting
the subunit-trace output which is generally useful.

Note that this dramatically increases output while running tests.
However, test failures are still at the bottom of the output, so it
shouldn't cause much pain, if any.

Change-Id: I4e0241eea113f994cadf68bdfe647065856d3a6d
2018-03-13 10:08:36 -07:00
Nguyen Hai b932046eb3 Change ironic-specs webpage from oslosphinx to openstackdocstheme
Change-Id: Ib9fdc57813d9812dd6ed69bf5a02076fa4e9db11
Closes-Bug: #1755165
2018-03-13 02:03:36 +09:00
Doug Hellmann d084bcf495 Add RSS feed
Publish an RSS feed of the changes to the specs repository to make the
specs more discoverable.

Change-Id: Ib4f84efab8b3af3ddd47d38d63a91362612bd655
2014-09-10 16:00:19 -04:00
Andreas Jaeger a699e290d0 Remove docutils pin
This was added to work around bug 1091333.  A new sphinx has been
released and so this is no longer necessary.

Change-Id: I9107884d964757a9154bdd1feb4ea6df4e9df43e
2014-08-27 20:30:49 +02:00
Steve Martinelli fcc21aeaad Update spec theme to show incubation status
Since ironic is an incubation project, it should be using the
incubation option in oslosphinx.

Change-Id: I28899f5d8af36846948b468b94fef8622e4bc30d
2014-08-22 11:07:14 -04:00
Longgeek d895f42f7f Update pbr version
Change-Id: Ie00b3f1d76152bcdecc30c9bda267ff397be838c
2014-06-28 23:14:14 +08:00
Devananda van der Veen 161a82f218 Initial commit
This imports the structure, unit tests, and template from nova-specs, creating
a functional specs repository without any approved specs.

Some modifications were made to the template to make it more applicable to
Ironic, eg. by adding sections and comments to existing sections where relevant
to bare metal provisioning.

Change-Id: I0b1ccd4a283d1c670a6ce497677dea8f47457f00
2014-05-22 15:51:33 -07:00