search

openhwgroup / core-v-mcu

This is the CORE-V MCU project, hosting CORE-V's embedded-class cores.
https://docs.openhwgroup.org/projects/core-v-mcu
Other
158 stars 50 forks source link

[BUG] docs sphinx_markdown_tables __init__() takes 2 but 3 given #327

Open emelcher opened 7 months ago

emelcher commented 7 months ago

Is there an existing core-v-mcu bug for this?

Bug Description

make docs ... reading sources... [ 3%] doc-src/apb_peripheral_interconnect
Extension error (sphinx_markdown_tables): Handler <function process_tables at 0x7ffaf3765730> for event 'source-read' threw an exception (exception: init() takes 2 positional arguments but 3 were given)

MikeOpenHWGroup commented 7 months ago

Hi @emelcher, thanks for your Issue. I will investigate. In the meantime, the docs are on-line here.

MikeOpenHWGroup commented 7 months ago

Hi @emelcher, I am unable to reproduce your problem. For me the make docs command runs as expected. Have you installed all the required python tools? Depending on your installation set-up, you may require additional plugs-ins to be installed:

$ pip install pdflatex
$ apt-get install texlive-latex-base
$ apt-get install texlive-latex-extra

Please give this a try and let me know if it resolves your issue, and if it does, you can close this issue. Otherwise, the issue will be closed within a from today. Thanks!

emelcher commented 7 months ago

Hi Mike,

I am working on CentOS, not Ubuntu. After pip3 install pdflatex, the error was the same. $ rpm -qa |grep texlive-latex texlive-latex-bin-bin-svn14050.0-45.20130427_r30134.el7.noarch texlive-latexconfig-svn28991.0-45.el7.noarch texlive-latex-svn27907.0-45.el7.noarch texlive-latex-fonts-svn28888.0-45.el7.noarch texlive-latex-bin-svn26689.0-45.el7.noarch

MikeOpenHWGroup commented 7 months ago

You'll need to resolve this on your own @emelcher - we do not have the resources to support all user platforms.

If you are able to resolve the issue for CentOS, we would be happen to receive a pull-request from you to update our scripts.

In the meantime, you can forgo the generation of a PDF on your local system. It seems that the HTML is being generated properly. This is the preferred option in any case - Sphinx goes a much better job of HTML rendering than it does for the PDFs.