Skip to content

Commit 05d2558

Browse files
committed
doc: move graphviz material to developer-guides
Rather than a "tutorial", it was suggested to move the graphviz information to the devleoper-guides, along with the documentation guidelines. Makes sense. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 5d94e9b commit 05d2558

File tree

8 files changed

+41
-1
lines changed

8 files changed

+41
-1
lines changed

doc/developer-guides/doc_guidelines.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,3 +393,42 @@ the first non-white space in the preceding line. For example:
393393
Keep the line length for documentation less than 80 characters to make
394394
it easier for reviewing in GitHub. Long lines because of URL references
395395
are an allowed exception.
396+
397+
Drawings
398+
********
399+
400+
You can include a picture (.jpg, .png, .svg for example) by using the
401+
``.. image`` directive::
402+
403+
.. image:: ../images/ACRNlogo.png
404+
:align: center
405+
406+
This results in the image being placed in the document:
407+
408+
.. image:: ../images/ACRNlogo.png
409+
:align: center
410+
411+
Alternatively, use the ``.. figure`` directive to include a picture with
412+
a caption and automatic figure numbering for
413+
your image, (so you can say see :numref:`acrn-logo-figure`, by using the
414+
notation ``:numref:`acrn-logo-figure``` and specifying the name of
415+
figure)::
416+
417+
.. figure:: ../images/ACRNlogo.png
418+
:align: center
419+
:name: acrn-logo-figure
420+
421+
Caption for the figure
422+
423+
.. figure:: ../images/ACRNlogo.png
424+
:align: center
425+
:name: acrn-logo-figure
426+
427+
Caption for the figure
428+
429+
430+
We've also included the ``graphviz`` Sphinx extension to let you use a text
431+
description language to render drawings. See :ref:`graphviz-examples` for more
432+
information.
433+
434+

doc/tutorials/graphviz.rst renamed to doc/developer-guides/graphviz.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. graphviz-examples:
1+
.. _graphviz-examples:
22

33
Drawings using graphviz
44
#######################

doc/developer-guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ project.
2323

2424
contribute_guidelines.rst
2525
doc_guidelines.rst
26+
graphviz.rst

0 commit comments

Comments
 (0)