question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Need documentation for table directives

See original GitHub issue

Is your feature request related to a problem? Please describe. I have not been able to add table directive. For example, the following does not work

+--------------+----------+------------+-------+
|              | Training | Validation | Test  |
+==============+==========+============+=======+
| Class 0      | 0        | 5          | 81    |
+--------------+----------+------------+-------+
| Class 1      | 13720    | 2744       | 52136 |
+--------------+----------+------------+-------+

The error is: WARNING: Error parsing content block for the “table” directive: exactly one table expected.

What should I do to make it work? I could not find any direction in the documentation. Also, after being able to make it work, how do I refer to tables like what I can do with figures?

A link to the documentation page where you see an issue.

Describe the solution you’d like

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
nhanitvncommented, May 28, 2020

Awesome @najuzilu . I confirm that I can render the table and refer to it now. Thanks a lot!!!

1reaction
najuzilucommented, May 27, 2020

According to the Sphinx documentation here, the list-table directive takes in one possible argument which is the title.

```{list-table} Title here
:header-rows: 1
:name: table1

* - Col1
  - Col2
* - Row1 under Col1
  - Row1 under Col2
* - Row2 under Col1
  - Row2 under Col2
```

The table can be referenced as follows

This table {numref}`table1` is an example.
Read more comments on GitHub >

github_iconTop Results From Across the Web

reStructuredText Directives - Docutils - SourceForge
Common Options. This document describes the directives implemented in the reference reStructuredText parser. Directives have the following syntax:
Read more >
needtable - Sphinx-Needs 1.1.0 documentation
needtable generates a table, based on the result of given filters. Example ... needtable supports the full filtering possibilities of Sphinx-Needs.
Read more >
Directives — Sphinx documentation
To create table of contents for current document (.rst file), use the standard reST contents directive. .. toctree::¶. This directive inserts ...
Read more >
Table directives
There are six directives for table processing. All must be at the beginning of a line to have any effect. Contents [ showhide...
Read more >
Guide: Designing Documents: Using Tables - Writing@CSU
Follow the publication's style or instructor's guidelines for Tables · Place titles above Tables · Write complete descriptive titles · Limit divider rules...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found