Skip to content

Resolve #24: latex build failed #25

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Resolve #24: latex build failed #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de7c7ae
for each custom directive add objtype equal to rust:<type>
PierreEtienneJ May 21, 2025
ffd1f02
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions python/sphinx_rust/directives/crate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def run(self) -> list[nodes.Node]:
root += nodes.paragraph("", f"Version: {crate.version}")

desc = addnodes.desc()
desc["objtype"] = f"{self.rust_domain.name}:crate"
root += desc
signature = addnodes.desc_signature(crate.name, f"pub mod {crate.name};")
desc += signature
Expand Down
2 changes: 2 additions & 0 deletions python/sphinx_rust/directives/enum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ def run(self) -> list[nodes.Node]:
desc = addnodes.desc()
root += desc
if enum.variants:
desc["objtype"] = f"{self.rust_domain.name}:struct"
sig_lines = [addnodes.desc_signature_line("", f"pub struct {enum.name} {{")]
for var in enum.variants:
# TODO types
Expand All @@ -61,6 +62,7 @@ def run(self) -> list[nodes.Node]:
signature = addnodes.desc_signature(enum.path_str, "", *sig_lines)
signature["is_multiline"] = True
else:
desc["objtype"] = f"{self.rust_domain.name}:enum"
signature = addnodes.desc_signature(
enum.path_str, f"pub enum {enum.name} {{}}"
)
Expand Down
1 change: 1 addition & 0 deletions python/sphinx_rust/directives/function.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ def run(self) -> list[nodes.Node]:
root = nodes.Element()

desc = addnodes.desc()
desc["objtype"] = f"{self.rust_domain.name}:function"
root += desc
signature = addnodes.desc_signature(
func.path_str,
Expand Down
3 changes: 3 additions & 0 deletions python/sphinx_rust/directives/module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ def run(self) -> list[nodes.Node]:
root = nodes.Element()

desc = addnodes.desc()

desc["objtype"] = f"{self.rust_domain.name}:module"

root += desc
signature = addnodes.desc_signature(module.path_str, f"pub mod {module.name};")
desc += signature
Expand Down
1 change: 1 addition & 0 deletions python/sphinx_rust/directives/struct.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ def run(self) -> list[nodes.Node]:
root = nodes.Element()

desc = addnodes.desc()
desc["objtype"] = f"{self.rust_domain.name}:struct"
root += desc
if struct.fields:
sig_lines = [
Expand Down