search

Xilinx / video-sdk

https://xilinx.github.io/video-sdk
Other
30 stars 14 forks source link

Specify versions for gh-pages build tools #89

Open pierrelefevre opened 3 months ago

pierrelefevre commented 3 months ago

Hi, I was trying to send a small PR for some typos in the docs, however installing the required pip packages specified in the readme: 

  pip3 install -U sphinx
  pip3 install recommonmark
  pip3 install sphinx-copybutton
  pip3 install sphinx-markdown-tables
  pip3 install rst2pdf

results in build errors due to an incompatible version of sphinx, since the repo contains a deprecated way of escaping strings. 

WARNING: extlinks: Sphinx-6.0 will require a caption string to contain exactly one '%s' and all other '%' need to be escaped as '%%'.

With latest sphinx (7.2.6), it fails like this:

reading sources... [  7%] c_apis                                                                                                                                                                           
Exception occurred:
  File "/usr/local/python/3.10.13/lib/python3.10/site-packages/sphinx/ext/extlinks.py", line 103, in role
    title = caption % part
TypeError: not all arguments converted during string formatting

I tried installing the latest version before 6.0: 5.3.0 but this generates a different output to the existing one in the repo, with a bunch of added tags in all the HTLM files such as: 

        <script src="_static/sphinx_highlight.js"></script>

Maybe providing a requirements.txt could fix this?

Best, Pierre