Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error integrating timing diagram in sphinx #78

Open
christian-herber-nxp opened this issue Jul 4, 2023 · 2 comments
Open

Error integrating timing diagram in sphinx #78

christian-herber-nxp opened this issue Jul 4, 2023 · 2 comments

Comments

@christian-herber-nxp
Copy link

Given the following example (based on https://plantuml.com/en/timing-diagram):

.. uml::

  clock   "Clock_0"   as C0 with period 50
  clock   "Clock_1"   as C1 with period 50 pulse 15 offset 10
  binary  "Binary"  as B
  concise "Concise" as C
  robust  "Robust"  as R
  analog  "Analog"  as A


  @0
  C is Idle
  R is Idle
  A is 0

  @100
  B is high
  C is Waiting
  R is Processing
  A is 3

  @300
  R is Waiting
  A is 1

sphinx/plantuml is failing to create the diagram. The resulting message is

WARNING: error while running plantuml

b'ERROR\n1\nSyntax Error?\nSome diagram description contains errors\n'

Simpler diagrams work, e.g.

.. uml::

  robust "Web Browser" as WB
  concise "Web User" as WU

  @0
  WU is Idle
  WB is Idle

  @100
  WU is Waiting
  WB is Processing

  @300
  WB is Waiting

is a working example. Where does this fall apart? Hopefully something that can be fixed.

@rhempel
Copy link

rhempel commented Oct 18, 2023

From my own experiments, the timing diagram plugin can handle simple clock statements like this:

clock Clock_0 with period 50

but adding some modifiers like offset or as fails

On my Ubuntu box, the most recent version of plantuml package is 1.2020.2 - which is a bit silly

@rhempel
Copy link

rhempel commented Oct 18, 2023

I have just removed the out of date Ubuntu provided package for plantuml, and installed the default-jre packeage. Then manually downloaded the latest pre-compiled plantuml jar file and pointed Sphinx at that file.

The example now builds correctly - recommend this issue be closed with a note to update to the latest PlantUML ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants