making docs

Print Thread

making docs #118080 11/03/20 08:53 PM
Joined: Feb 2014 Posts: 527 Likes: 1 G Golden Child OP Senior Member
OP Golden Child Senior Member G Joined: Feb 2014 Posts: 527 Likes: 1	Hi guys, Just noticed there's a docs directory with a makefile. So after "cd docs" and trying to "make html" I get: Code $ make html sphinx-build -b html -d build/doctrees source build/html Running Sphinx v1.8.5 Extension error: Could not import extension sphinxcontrib.rsvgconverter (exception: No module named 'sphinxcontrib') make: *** [Makefile:50: html] Error 2 I'm running ubuntu and did a "sudo apt install sphinxsearch" and "sudo apt install sphinx-common" "sudo apt install python3-sphinx" What else do I need?

Re: making docs Golden Child #118086 11/04/20 12:08 AM
Joined: Feb 2004 Posts: 2,217 Likes: 5 Sydney, Australia Vas Crabb Very Senior Member
Vas Crabb Very Senior Member Joined: Feb 2004 Posts: 2,217 Likes: 5 Sydney, Australia	The answer is right there in the error message…

Re: making docs

Vas Crabb #118087 11/04/20 02:02 AM

Joined: Feb 2014

Posts: 527

Likes: 1

Golden Child Offline

Senior Member

Golden Child

Senior Member

Joined: Feb 2014

Posts: 527

Likes: 1

ok, so looks like I need to install a couple of things:

some instructions at:
https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter
https://packaging.python.org/guides...ptools-wheel-with-linux-package-managers

sudo apt install python3-venv python3-pip

pip3 install sphinxcontrib-svg2pdfconverter

Code

$ make html
sphinx-build -b html -d build/doctrees source build/html
Running Sphinx v1.8.5
making output directory...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 57 source files that are out of date
updating environment: 57 added, 0 changed, 0 removed
reading sources... [100%] whatis
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] whatis
WARNING: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting
WARNING: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting
generating indices... genindex
writing additional pages... search
copying images... [100%] usingmame/images/mahjongpanel.svg
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in build/html.
Build finished. The HTML pages are in build/html.

It complains that rsvg-convert isn't there, so:

Code

$ rsvgconvert

Command 'rsvgconvert' not found, did you mean:

  command 'rsvg-convert' from deb librsvg2-bin (2.48.7-1ubuntu0.20.04.1)

Try: sudo apt install <deb name>

$ sudo apt install librsvg2-bin



$ make html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.8.5
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.
build succeeded.

The HTML pages are in build/html.

Build finished. The HTML pages are in build/html.

Moderated by Bletch, R. Belmont, Richard Bannister

Link Copied to Clipboard

Home Page Forums MAME MAME making docs