Add language info in doc samples
Bug #1360559 reported by
Gauvain Pocentek
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| OpenStack Heat |
Fix Released
|
Medium
|
Gauvain Pocentek | ||
Bug Description
The sphinx extension could provide language (yaml, json, hot) information in the code samples.
This could be used to add syntax highlighting to the docbook generated hot reference (docs BP heat-templates).
| Changed in heat: | |
| assignee: | nobody → Gauvain Pocentek (gpocentek) |
| Changed in heat: | |
| status: | New → In Progress |
| Changed in heat: | |
| importance: | Undecided → Medium |
| milestone: | none → juno-3 |
Revision history for this message
| OpenStack Infra (hudson-openstack) wrote Fix merged to heat (master) | #1 |
| Changed in heat: | |
| status: | In Progress → Fix Committed |
| Changed in heat: | |
| status: | Fix Committed → Fix Released |
| Changed in heat: | |
| milestone: | juno-3 → 2014.2 |
To post a comment you must log in.
Reviewed: https:/
Committed: https:/
Submitter: Jenkins
Branch: master
commit 28231c1b188c6d9
Author: Gauvain Pocentek <email address hidden>
Date: Sun Aug 3 16:49:10 2014 +0200
Add language attribute to code samples
Create the literal_block nodes with a 'language' attribute to add syntax
highlighting in the generated documentation.
This change is not visible in the HTML output, but is used when the
generated XML is imported in the openstack-manuals hot-reference book
(WIP).
The 'hot' language is not currently supported in sphinx or in the
manuals, but it doesn't hurt to have it and it could be implemented
later.
Change-Id: Ie5d4ab31665da8
Implements: blueprint heat-templates
Closes-Bug: #1360559