Comments (11)
tleb
commented on June 2, 2024
2
For reference, Akira Yokosawa sent a patch on May 1th.
It got queued by Jonathan Corbet on May 2nd, meaning this issue can probably be closed. It'll be backported to stable kernel releases as well.
from sphinx.
chrisjsewell
commented on June 2, 2024
1
Thanks @kanakshilledar, I got a bit stalled trying to build the docs on my Mac, which wasn't as trivial as I'd hoped. But I think I'll just send out the patch tomorrow, now that you've confirmed it works 😄
from sphinx.
AA-Turner
commented on June 2, 2024
Can you try with Docutils 0.20.* or 0.19.*?
A
from sphinx.
Ramen-LadyHKG
commented on June 2, 2024
Docutils
sure
but I'm not sure how to do this. My docutils is installed in a python virtual environment.
What I don't know, is if the kernel compiling script is using that library or compiling its own python library.
Because I tried to remove to env and the compiler is still going.
HENCE,
I've to look into the makepkg, make config. Maybe the dependencies version request it's within.
from sphinx.
chrisjsewell
commented on June 2, 2024
Can you try with Docutils 0.20.* or 0.19.*?
FYI, the reason for this is that docutils removed reprunicode in v0.21.
I don't see this used in sphinx 7.3.7, do you perhaps use any other sphinx extensions, what does your conf.py look like?
from sphinx.
kanakshilledar
commented on June 2, 2024
I am also getting the same error while duing make htmldocs for the linux kernel.
Any idea on how can I solve this error?
conf.py of linux kernel looks like this (https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/Documentation/conf.py?h=v6.8.8)
from sphinx.
chrisjsewell
commented on June 2, 2024
From b059be87d593687210a409a5be1ecd6d28941a62 Mon Sep 17 00:00:00 2001
From: Chris Sewell <[email protected]>
Date: Tue, 30 Apr 2024 20:58:56 +0200
Subject: [PATCH] fix sphinx docs build
---
Documentation/sphinx/kernel_include.py | 1 -
1 file changed, 1 deletion(-)
diff --git a/Documentation/sphinx/kernel_include.py b/Documentation/sphinx/kernel_include.py
index abe768088377..638762442336 100755
--- a/Documentation/sphinx/kernel_include.py
+++ b/Documentation/sphinx/kernel_include.py
@@ -97,7 +97,6 @@ class KernelInclude(Include):
# HINT: this is the only line I had to change / commented out:
#path = utils.relative_path(None, path)
- path = nodes.reprunicode(path)
encoding = self.options.get(
'encoding', self.state.document.settings.input_encoding)
e_handler=self.state.document.settings.input_encoding_error_handler
--
2.41.0See the change in docutils here: live-clones/docutils@d979a5d
do I get a commit attribution on the linux kernel 😄?
from sphinx.
kanakshilledar
commented on June 2, 2024
Yes definitely you can create the patch and send it to the mailing list.
Follow this article on a high level understanding of the process and steps. If you want more detailed one you can refer the indepth guide
from sphinx.
Ramen-LadyHKG
commented on June 2, 2024
Got some new errors
BTF [M] net/qrtr/qrtr-smd.ko [10/1991]
BTF [M] net/qrtr/qrtr.ko
BTF [M] net/hsr/hsr.ko
BTF [M] net/qrtr/qrtr-mhi.ko
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
Traceback (most recent call last):
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
import yaml
import yaml
ModuleNotFoundError: No module named 'yaml'
ModuleNotFoundError: No module named 'yaml'
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
ModuleNotFoundError: No module named 'yaml'
Traceback (most recent call last):
File "/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/./tools/net/ynl/ynl-gen-rst.py", line 26, in <module>
import yaml
ModuleNotFoundError: No module named 'yaml'
import yaml
ModuleNotFoundError: No module named 'yaml'
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/mptcp_pm.rst] Error 1
make[2]: *** Waiting for unfinished jobs....
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/dpll.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/fou.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/nfsd.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/nlctrl.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/ovs_datapath.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/netdev.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/ethtool.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/handshake.rst] Error 1
make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/devlink.rst] Error 1
make[1]: *** [/home/curie/.cache/yay/linux-drm-tip-git/src/linux-drm-tip-git/Makefile:1703: htmldocs] Error 2 make: *** [Makefile:240: __sub-make] Error 2
==> ERROR: A failure occurred in build().
Aborting...
-> error making: linux-drm-tip-git-exit status 4
-> Failed to install the following packages. Manual intervention is required:
linux-drm-tip-git - exit status 4
from sphinx.
kanakshilledar
commented on June 2, 2024
I was able to build the documentation properly with the changes suggested by @chrisjsewell in the above patch.
Can you check if you have the yaml module installed. Try pip3 install pyyaml.
Hope this helps.
from sphinx.
Ramen-LadyHKG
commented on June 2, 2024
For reference, Akira Yokosawa sent a patch on May 1th. It got queued by Jonathan Corbet on May 2nd, meaning this issue can probably be closed. It'll be backported to stable kernel releases as well.
I fixed on my side just remove kernel_doc dependency on make config.
but I agree, just close it
from sphinx.
Related Issues (20)
- LaTeX/ImageConverter: Regression with `data:` URIs HOT 1
- Have emoji and U+28FF working in sphinx ``lualatex`` generated for titles and code HOT 6
- Should `defusedxml` be moved to the runtime dependencies? HOT 5
- sphinx-build hard-codes the python path into the exe HOT 7
- ext.napoleon to work with ext.todo HOT 2
- `:loading: embed` on images does not work as expected HOT 7
- ``todo`` directive treat repeated special characters as headers
- toc_object_entries uses language (Python) scoping instead of documentation scoping HOT 2
- TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html HOT 1
- Index pages use `–` but it can not be used in ePub HOT 3
- Intersphinx Mapping link not working with Plotly objects in signature HOT 4
- Internationalization doc mentions deprecated transifex-client HOT 1
- 7.3.7: missing `defusedxml` install time dependency HOT 2
- THYDUX COIN 𝕏 🥏
- Multiple labels inside math directives HOT 1
- LaTeX: footnote mark may indicate "Page N, M" but footnote M is already on page N
- Gettext builder cannot extract 'option' directive HOT 3
- `autodoc_class_signature = "separated"` cause a warning for enum with no `__init__` HOT 12
- [search] issues with the new HTML search algorithm HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx.