[Openstack-docs] Markdown conversion challenges

Sam Harwell sam.harwell at RACKSPACE.COM
Wed Feb 26 17:32:43 UTC 2014


Hi Andreas,

I was suggesting that the toolchain could be updated to recognize a comment in the Markdown file having that format. Until the toolchain supports this special syntax, it will treat it like any other XML comment (i.e. ignored).

David Cramer could create an appropriate patch to detect and translate an XML comment having that specific syntax at the beginning of the file.

Thanks,
Sam

-----Original Message-----
From: Andreas Jaeger [mailto:aj at suse.com] 
Sent: Wednesday, February 26, 2014 9:41 AM
To: Sam Harwell; openstack-docs at lists.openstack.org
Cc: dolph.mathews at gmail.com
Subject: Re: [Openstack-docs] Markdown conversion challenges

On 02/26/2014 02:49 PM, Sam Harwell wrote:
> <!-- % Title -->
> [...]

I've made such a change now - see:
https://review.openstack.org/76556

Result of this as markdown:
https://github.com/ajaeger/identity-api/blob/master/openstack-identity-api/v3/src/markdown/identity-api-v3.md

But the built book is wrong, it has "Chapter 1. NO TITLE", see the published book:

http://docs-draft.openstack.org/56/76556/1/check/gate-identity-api-tox-doc-publish-checkbuild/3c95a8b/publish-docs/api/openstack-identity-service/3/content/index.html

Andreas
--
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list