RE: Question about Sphinx tables

[Mark Rivers via Tech-talk <tech-talk@aps.anl.gov>]

Hi Mark and Tom,

 

Thanks for the reply.  I found that this works well:

 

.. cssclass:: table-bordered table-striped table-hover

.. csv-table::

   :header: Record names, Record types, GenICam features

   :delim: |

   :widths: auto

 

I added the lines in red.  The table now appears as in the attachment.

 

I have another question.  The CSV table documentation here http://docutils.sourceforge.net/docs/ref/rst/directives.html#id4 says that csv-table takes a “width” option, which specifies the width in absolute units or relative to the current line length.  However, I get an error when I try to use that option.

 

/home/epics/devel/areaDetector-3-6/docs/_docs/ADGenICam/ADGenICam.rst:507: WARNING: Error in "csv-table" directive:

unknown option: "width".

 

.. csv-table::

   :header: Record names, Record types, GenICam features

   :delim: |

   :widths: auto

   :width: 50%

 

Any idea why I am getting the error?

 

Thanks,

Mark

 

 

 

From: Engbretson, Mark S. <engbretson@anl.gov>
Sent: Monday, June 17, 2019 9:56 AM
To: Mark Rivers <rivers@cars.uchicago.edu>
Subject: RE: Question about Sphinx tables

 

https://pythonhosted.org/sphinxjp.themes.basicstrap/sample.html#grid

 

.. cssclass:: table-bordered

 

Maybe?

 

From: tech-talk-bounces@aps.anl.gov <tech-talk-bounces@aps.anl.gov> On Behalf Of Mark Rivers via Tech-talk
Sent: Monday, June 17, 2019 9:44 AM
To: tech-talk@aps.anl.gov
Subject: Question about Sphinx tables

 

Folks,

 

Thanks to a lot of work by Stuart Wilkins the areaDetector documentation is moving from pure HTML to .rst files processed with Sphinx and hosted at https://areadetector.github.io/master/index.html.

 

I have a question about how to make the tables look better. 

 

I have a simple CSV table:

 

.. csv-table::

   :header: Record names, Record types, GenICam features

   :delim: |

 

   FrameRate, FrameRate_RBV | ao, ai | FrameRate or FrameRateAbs

   FrameRateEnable, FrameRateEnable_RBV | bo, bi| FrameRateEnable or FrameRateEnabled

   TriggerSource, TriggerSource_RBV | mbbo, mbbi | TriggerSource

   TriggerOverlap, TriggerOverlap_RBV | mbbo, mbbi | TriggerOverlap

   TriggerSoftware | bo | TriggerSoftware

   ExposureMode, ExposureMode_RBV | mbbo, mbbi | ExposureMode

   ExposureAuto, ExposureAuto_RBV | mbbo, mbbi | ExposureAuto

   GainAuto, GainAuto_RBV | mbbo, mbbi | GainAuto

   PixelFormat, PixelFormat_RBV | mbbo, mbbi | PixelFormat

 

Sphinx generates this HTML for the beginning of the table:

 

<table border="1" class="docutils">

<colgroup>

<col width="33%" />

<col width="33%" />

<col width="33%" />

</colgroup>

<thead valign="bottom">

<tr class="row-odd"><th class="head">Record names</th>

<th class="head">Record types</th>

<th class="head">GenICam features</th>

</tr>

</thead>

<tbody valign="top">

<tr class="row-even"><td>FrameRate, FrameRate_RBV</td>

<td>ao, ai</td>

<td>FrameRate or FrameRateAbs</td>

 

Note that it has border=”1”, so the table should have borders.  However, it actually renders (in Chrome) as shown in the attachment, i.e. with no borders.

 

I manually edited the HTML to change it to “border=5” and that made no difference, there are still no borders.

 

If I remove the class=”docutils” from the table line, then it does render differently (closely packed columns), but there are still no borders.

 

Can anyone tell me what is causing this behavior?  I suspect it may be related to these lines near the beginning of the generated HTML file:

 

    <link rel="stylesheet" href="" type="text/css" />

    <link rel="stylesheet" href="" type="text/css" />

 

Do those style sheets override the settings for tables?  I looked at those files and I did not see anything obvious for the table borders.

 

Is there a way to get borders?

 

Thanks,

Mark

 

 

 

Attachment: sphinx_table.png
Description: sphinx_table.png