Unable to build Sphnix documentation on macOS

Open
#234 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
28/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

The failure occurs while docs/source/conf.py imports version from yaramail/init.py; start by reproducing make html on macOS and inspecting the reported yara native-library import error. Done means the Sphinx documentation builds successfully on macOS as it does on Debian.

Written by the indexing model from the issue text.

Description

Building Sphinx documentation works fine in Debian but fails in macOS

Running Sphinx v6.1.3

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/Users/sean/dev/yaramail/venv/lib/python3.10/site-packages/sphinx/config.py", line 351, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/Users/sean/dev/yaramail/docs/source/conf.py", line 17, in <module>
    from yaramail import __version__
  File "/Users/sean/dev/yaramail/yaramail/__init__.py", line 9, in <module>
    import yara
ImportError: dlopen(/Users/sean/dev/yaramail/venv/lib/python3.10/site-packages/yara.cpython-310-darwin.so, 0x0002): symbol not found in flat namespace '_EVP_MD_get_size'

make: *** [html] Error 2
Dominant language
C
Stars
754
Forks
190
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VirusTotal/yara-python

All issues in VirusTotal/yara-python

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.