[openstack-dev] [infra] support graphviz in document publishing

Andreas Jaeger aj at suse.com
Mon Nov 13 09:41:55 UTC 2017


On 2017-11-13 10:16,  Yujun Zhang (ZTE)  wrote:
> Hi, all
> 
> Sometimes a picture worths thousands word. I wonder if it is possible to
> support graphviz in https://docs.openstack.org/
> 
> What I expect is to include a dot file and render it as a picture in
> HTML output. The syntax is simple
> 
> .. graphviz:: aggregate-equivalent-alarms.files/example.dot
> 
> And should be supported by sphinx graphviz plugin[2]
> 
> See full example[1]. Currently I render the picture offline and include
> it manually in the document. It would be much more convenient for
> developer if the extension is added to document build job.

You can easily include them for any repository - add the python
requirements to test-requirments and add the binary requirements to
bindep.txt - as explained in
https://docs.openstack.org/infra/manual/drivers.html#package-requirements

Andreas

> [1]:
> https://review.openstack.org/#/c/518196/5/proposals/aggregate-equivalent-alarms.rst
> [2]: http://www.sphinx-doc.org/en/stable/ext/graphviz.html
> 
> -- 
> Yujun Zhang
> 
> 
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> 


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
       HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-dev mailing list