-
Notifications
You must be signed in to change notification settings - Fork 80
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
1.0.0: documentation build fails #558
Comments
Q: why documentation build is trying to update some modules? 🤔 |
OK, I can see why this would happen. We use entrypoints to facilitate extensibility. These entrypoints require a package to be installed. This isn't something that we can really fix - is there a reason that you can't run sphinx with the package installed? |
Building package I cannot install anything (build is performed from non-root account) and packaging procedure should not be about installing anything. |
I don't think there should be anything wrong with requiring a package to be installed in order for its documentation to be built. I am not intimately familiar with OS packaging processes, however. Is it possible for you to create a virtual environment that is used during building? |
Let me show you something [tkloczko@pers-jacek SPECS]$ grep %sphinx_build_man -l python-*spec| wc -l; ls -1 python-*.spec | wc -l
671
1217 So it means that I have +1.2k rpm packa build procedures in form of rpm spec files and amongst those files +670 is able to produce man page using sphinx. [tkloczko@pers-jacek SPECS]$ rpm -E %sphinx_build_man
\
PBR_VERSION=%{version} \
PDM_BUILD_SCM_VERSION=%{version} \
SETUPTOOLS_SCM_PRETEND_VERSION=%{version} \
JARACO_PACKAGING_SPHINX_WHEEL=$(ls -1 $PWD/dist/*whl) \
/usr/bin/sphinx-build -n -T -b man docs build/sphinx/man Amongst all those python modules literally NONE requires such special approach which is in this case .. Q: what makes impossible to use only source tree without installing anything to build documentation? Building documentation out of ONLY source tree has IMO huge advantage because it provides 100% guarantee that documentation will be build out of source tree ano not out of installed module (which may ne not the same version). 😋 |
Describe the bug
Looks like documentation build still fail.
Reproduce the bug
I'm building documentation without have
myst-nb
installed.It is possible to do that with below patch
That kind of hack is listed in example sphinx conf.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file
With that patch documentation build fails with
List your environment
Here is list of installed modules in build env
The text was updated successfully, but these errors were encountered: