arth-ur/sphinxcontrib-bitfield

Sphinx extension for rendering bitfields

sphinxcontrib-bitfield's Issues

"compact" always active

Hi,

I try to generate a old documentation with a new installation. For some reason the "compact" flag seems to be active all the time. Do you have a idea, what's wrong?

My bitfield.rst:

.. bitfield::
    :bits: 32
    :lanes: 1

    [
       { "name": "Read and Write", "bits": 8, "type": 5 },
       { "name": "Read only", "bits": 8, "type": 4 },
       { "name": "Write only", "bits": 8, "type": 3 },
       { "name": "Reserved", "bits": 8, "type": 1 }
    ]

Output:

Versions:
Sphinx 1.8.5
sphinxcontrib-bitfield 0.4.0
bit-field 0.4.0

If i run

bit_field test.json > test.svg

i get this

test.json:

    [
       { "name": "Read and Write", "bits": 8, "type": 5 },
       { "name": "Read only", "bits": 8, "type": 4 },
       { "name": "Write only", "bits": 8, "type": 3 },
       { "name": "Reserved", "bits": 8, "type": 1 }
    ]

Problem with PDF output

Hi,

I have seen issue #1. I've tried creating PDF output but the generated images are not aligned correctly: they are inline with the text and so go off the edge of the page (see attached screenshot).

Any idea what the problem is?

make latexpdf support?

Hi,
it looks like there is no support for pdf generation with "make latexpdf".
Can you confirm that?

The following error message can be seen:

Exception occurred: File "../python3.6/sie-packages/sphinx/writers/latex.py", line 2486, in unkown_visit rais NotImplemented Error('Unknown node: ' + node.class.name)
NotImplemented Error: Unknown node: bitfield

compact, vflip and hflip not behaving correctly

Great extension !

I am facing two annoying bugs though. I tried to use it with the following code (from the example):

.. bitfield::
    :bits: 32
    :lanes: 4
    :vflip:
    :hflip:

      [
        {"name": "IPO",   "bits": 8, "attr": "RO"},
        {                 "bits": 7},
        {"name": "BRK",   "bits": 5, "attr": ["RW", "FOO"], "type": 4},
        {"name": "CPK",   "bits": 2},
        {"name": "Clear", "bits": 3, "type": 5},
        {                 "bits": 7}
      ]

According to this page https://observablehq.com/@drom/bitfield-testbox
I shall get this

and I get this

In addition :compact: seems to be broken too, it has no impact.