openstack/openstack-manuals
Code Issues Proposed changes
9381741e63
openstack-manuals/doc/doc-contrib-guide/source/rst-conv/tables.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide 
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00

4.5 KiB
Raw Blame History

Tables

This section describes several types of tables that you can use in the OpenStack documentation. Each table must have a title. Name a table using the table directive. See corresponding subsections for the title formatting details.

For the style guidelines on table titles, see figure_table_titles.

Graphic tables

Use the graphic table formatting for the content that presupposes short lines of text and a small number of rows and columns.

Note

As the graphic tables are rather difficult to create and maintain, give the preference to list and CSV tables over the graphic ones, or format the content as definition lists where possible.

Input

.. table:: **Default flavors**

 ============  =========  ===============  =============
  Flavor         VCPUs      Disk (in GB)     RAM (in MB)
 ============  =========  ===============  =============
  m1.tiny        1          1                512
  m1.small       1          20               2048
  m1.medium      2          40               4096
  m1.large       4          80               8192
  m1.xlarge      8          160              16384
 ============  =========  ===============  =============

Output

Default flavors
Flavor VCPUs Disk (in GB) RAM (in MB)

m1.tiny

1

1

1

m1.small

1

20

2048

m1.medium

2

40

4096

m1.large

4

80

8192

m1.xlarge

8

160

16384

List tables

Use the list-table directive to create a table that contains a large number of rows and columns with the long lines within the cells.

Input

.. list-table:: **Quota descriptions**
   :widths: 10 25 10
   :header-rows: 1

   * - Quota Name
     - Defines the number of
     - Service
   * - Gigabytes
     - Volume gigabytes allowed for each project
     - Block Storage
   * - Instances
     - Instances allowed for each project.
     - Compute
   * - Injected File Content Bytes
     - Content bytes allowed for each injected file.
     - Compute

Output

Quota descriptions
Quota Name Defines the number of Service
Gigabytes Volume gigabytes allowed for each project Block Storage
Instances Instances allowed for each project. Compute
Injected File Content Bytes Content bytes allowed for each injected file. Compute

CSV tables

The csv-table directive enables creating a table from CSV (comma-separated values) data. It also supports RST inline markups, such as, emphasis, strong emphasis markups, code, command, and other directives.

Input

.. csv-table:: **ipv6_ra_mode and ipv6_address_mode combinations**
   :header: ipv6 ra mode, ipv6 address mode, "radvd A,M,O", "External Router A,M,O", Description
   :widths: 2, 2, 2, 2, 4

   *N/S*, *N/S*, Off, Not Defined, Backwards compatibility with pre-Juno IPv6 behavior.
   *N/S*, slaac, Off, "1,0,0", Guest instance obtains IPv6 address from non-OpenStack
   *N/S*, dhcpv6-stateful, Off, "0,1,1", Not currently implemented in the reference implementation.

Output

ipv6_ra_mode and ipv6_address_mode combinations
ipv6 ra mode ipv6 address mode radvd A,M,O External Router A,M,O Description
N/S N/S Off Not Defined Backwards compatibility with pre-Juno IPv6 behavior.
N/S slaac Off 1,0,0 Guest instance obtains IPv6 address from non-OpenStack
N/S dhcpv6-stateful Off 0,1,1 Not currently implemented in the reference implementation.

Useful links on table formatting