hammerspoon: Problem building docs

When running scripts/build.sh docs I get the following error:

Building docs HTML...
Traceback (most recent call last):
  File "/opt/amagill/src/hammerspoon/hammerspoon/scripts/docs/bin/build_docs.py", line 791, in <module>
    main()
  File "/opt/amagill/src/hammerspoon/hammerspoon/scripts/docs/bin/build_docs.py", line 781, in main
    write_html(arguments.output_dir + "/html/",
  File "/opt/amagill/src/hammerspoon/hammerspoon/scripts/docs/bin/build_docs.py", line 686, in write_html
    write_templated_output(output_dir, template_dir, title, source_url_base, data, "html")
  File "/opt/amagill/src/hammerspoon/hammerspoon/scripts/docs/bin/build_docs.py", line 651, in write_templated_output
    data = process_markdown(data)
  File "/opt/amagill/src/hammerspoon/hammerspoon/scripts/docs/bin/build_docs.py", line 444, in process_markdown
    class HighlightRenderer(mistune.HTMLRenderer):
AttributeError: module 'mistune' has no attribute 'HTMLRenderer'

Is there a module missing from requirements.txt or a specific version of mistune I should be using?

About this issue

Original URL
State: closed
Created 2 years ago
Comments: 15 (15 by maintainers)

Most upvoted comments

I get it, no problem… it was just different and broke my build script… however, once I understood what was going on, it actually simplified my build script!

IMHO, the section at https://github.com/Hammerspoon/hammerspoon/blob/master/CONTRIBUTING.md#how-is-everything-built on building is a little vague on specifics in a couple of places, but honestly I think a Wiki article would be a better place to go into detail, and I have a few of those to polish up and publish as well, so I hope to address that soon… may wait a bit on the build one to see what other tweaks you and @latenitefilms need to work out, but I’m good for now – got the newest development build on my M1 and Intel 12.x machines, and on my Catalina 10.15.7 machine (though I haven’t tried building it there yet) today, so I can start working on Hammerspoon again!

asmagill on Mar 10, 2022

I ran into this a few months ago - I believe this is a side-effect of us not specifying version numbers in requirements.txt - you have mistune installed, but probably an old enough version that its API has changed. It took me a very long time to track that one down.

FWIW, here are the versions I have installed:

❯ /usr/bin/pip3 list
Package    Version
---------- -------
Jinja2     3.0.3
MarkupSafe 2.0.1
mistune    2.0.0
pip        20.2.3
Pygments   2.11.2
setuptools 49.2.1
six        1.15.0
ttp        0.6.0
wheel      0.33.1

cmsj on Mar 9, 2022