Closed wuch-g2v closed 1 year ago
Hey, I believe this should not be related to Furo. Sphinx separates out "content" from "presentation". What happens if you change html_theme = "alabaster"
, i.e. one of the builtin themes.
Those warnings are about references incorrectly defined, As you see I'm generating man page to show you that it has nothing to do with theme.
Generating man pages is something I recommend that you do not try; that's not something that I expect to be necessary for an HTML theme. If you're using this website theme, it is expected that you'll be able to use a browser.
Beyond that, see https://github.com/pradyunsg/furo/blob/490527b2aef00b1198770c3389a1979911ee1fcb/noxfile.py#L68 for details on how to build the documentation of this theme.
The errors and nitpicks are because you aren't installing things that need to be installed in the documentation build environment.
Finally, this is not a "trackable task" for the project, which is the template used to file this issue. You've explicitly ignored "Please only use this, if you've been advised to do so after discussion." that was in the issue template selection page, which is not appreciated on my end.
I'll also point out that you could have figured out what the right thing to do here would be by reading https://pradyunsg.me/furo/contributing/workflow/#documentation-generation, which is the documentation of this project and linked to from multiple places.
Hmm... @wuch-g2v looks like a sock-puppet account for @kloczek, to circumvent direct blocking? The issues filed have the exact same style (and level of ignorance of written instructions + lack of research) as that user, and looking at the user's history, they've only filed issues in repositories where I know @kloczek is banned from interacting.
sigh
Yes, it is. From https://github.com/seleniumbase/SeleniumBase/issues/1899:
+ PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-seleniumbase-4.14.14-2.fc35.x86_64/usr/lib64/python3.8/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-seleniumbase-4.14.14-2.fc
I'm quoting build logs from build system. Is it any problem that I'm doing that and/or is what I'm reporting is bogus? 🤔
Again. I'm working with person which you've blocked.
Incorrect references exposed by -n
option are affecting html, qch and pdf output.
We are providing as general feedback what has been found during use our packaging procedure. If you want to ignore that issue that is perfectly fine as on packaging python modules used out approach is generated roff output out packages are not affected by what has been reported.
Reported issue is not critical by any meaning.
If want to punish messenger that is a bit odd .. Ticket has been closed. Maintainer has been informed about that issue. That was my goal. Everything else is out of the scope of this ticket.
sigh
I hope that you'd be willing to do any amount of self-reflection and understand what I'm trying to tell you.
Tomasz, please read project documentation for instructions and investigate the issue yourself before asking the project to investigate by filing issues, follow the contribution process of the project you're interacting with, and don't create sock puppets to circumvent bans.
We're done here.
What's happening?
First of all currently it is not possible to use straight
sphinx-build
command to build documentation out of source treeThis can be fixed by patch like below:
This patch bases on sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file
Than .. on building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues.Here is the output with warnings:
You can peak on fixes that kind of issues in other projects https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/RDFLib/rdflib/pull/2036 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/frostming/unearth/issues/14 https://github.com/jaraco/cssutils/issues/21 https://github.com/latchset/jwcrypto/pull/289 https://github.com/latchset/jwcrypto/pull/289 https://github.com/pypa/distlib/commit/98b9b89f https://github.com/pywbem/pywbem/pull/2895 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/sissaschool/xmlschema/commit/42ea98f2 https://github.com/sqlalchemy/sqlalchemy/commit/5e88e6e8
Reproducer
Just run
/usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
in root source tree.Expectation
sphinx should not generate warninx with
-n
option.Code of Conduct