Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing a warning in single HTML page documentation generation (sphinx) #549

Open
vhelin opened this issue Dec 11, 2022 · 4 comments
Open

Comments

@vhelin
Copy link
Owner

vhelin commented Dec 11, 2022

Here's the output I get when generating the documentation:


[ 99%] Generating simple text documentation
[ 99%] Built target doc-stext
[ 99%] Generating man pages
[ 99%] Built target doc-man
[100%] Generating single HTML page documentation
/usr/lib/python3.9/site-packages/sphinx/builders/html/__init__.py:626: FutureWarning: The configuration setting "embed_images" will be removed in Docutils 1.2. Use "image_loading: link".
  self.docwriter.write(doctree, destination)
[100%] Built target doc-shtml
[100%] Built target doc

I think I've had that warning there for a long time, so getting it fixed might be a good idea in the long term? Anyone here who knows how sphinx works (I don't)? :)

@jeffythedragonslayer
Copy link
Contributor

I tried getting it installed like the other tools PVSnesLib uses, do you know if it's available through pacman?

# pacman -S sphinx
error: target not found: sphinx

@vhelin
Copy link
Owner Author

vhelin commented Jan 31, 2023

The only pacman I know is a Japanese video game LOL. :D Help here, anyone?

@jeffythedragonslayer
Copy link
Contributor

Here is the official documentation:

https://www.sphinx-doc.org/en/master/usage/installation.html

I get the same error with both pacman -S python3-sphinx and pacman -S python-sphinx though.

@jeffythedragonslayer
Copy link
Contributor

jeffythedragonslayer commented Feb 4, 2023

It was very difficult but I made some progress on getting sphinx installed. First add these lines to /etc/pacman.conf:

[community]
SigLevel = Never

I also did:

wget ftp://mirror.csclub.uwaterloo.ca/archlinux/community/os/x86_64/community.db

and moved them like described here: https://unix.stackexchange.com/questions/34606/pacman-could-not-find-database

Then I was able to get to:

$ pacman -S community/python-sphinx
resolving dependencies...
warning: cannot resolve "python-requests", a dependency of "python-sphinx"
:: The following package cannot be upgraded due to unresolvable dependencies:
      python-sphinx

:: Do you want to skip the above package for this upgrade? [Y/n] Y
looking for conflicting packages...
 there is nothing to do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants