rst-xml conversion automation
This code is used to convert devref project rst documentation into xml that the openstack manuals project can use. The Training-manuals sub-project will use xi:include statements so the converted xml becomes part of the training guides during build. The conversion script will live in the ./training-
Code details (also in the comments of the script): The code must executed within ./openstack-
create_repo: clones the nova, glance, cinder, neutron, swift, keystone, oslo, and horizon repositories into the directory above openstack-manuals repository. It is assumed this is where repositories belong on the local system.
pull_repo_updates: Intended that all the local repositories are to be pulled for updates before starting a new branch.
convert_rst: use pandoc to convert the rst to docbook 4.5 xml. Copy over images as well.
rst_xml_cleanup: convert docbook 4.5 xml to docbook 5.0 along with some cleanup of poorly formatted tags.
Before the rst xml conversion results are accepted in their entirety, a first patch to openstack-manuals will only include the rst files from the cinder project.
the repo array contains only 'cinder'
maybe use xslt plus regex to go from 4.5 to 5.0
That patch is here ....
Blueprint information
- Status:
- Complete
- Approver:
- Sean Roberts
- Priority:
- Undefined
- Drafter:
- Sean Roberts
- Direction:
- Needs approval
- Assignee:
- Sean Roberts
- Definition:
- Superseded
- Series goal:
- None
- Implementation:
- Started
- Milestone target:
- None
- Started by
- Sean Roberts
- Completed by
- Sean Roberts
Related branches
Related bugs
Sprints
Whiteboard
cinder only version has been pushed to gerrit for review as per discussion with annegentle and nermina
Gerrit topic: https:/
Addressed by: https:/
rst to xml conversion for project devref rst material
Addressed by: https:/
rst-
Work Items
Work items:
socialize purpose: DONE
code review: INPROGRESS
timing of release: INPROGRESS