Skip to content

Conversation

@scemama
Copy link
Member

@scemama scemama commented Jan 10, 2025

Now, the rust interface finds the trexio.h file on the system and extracts the JSON from it. It avoids downloading and compiling a trexio special for rust.

@@ -0,0 +1,2295 @@
/* This file was generated from the templator_front.org org-mode file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the trexio.h in our git tree if the goal of this PR is to discover it at build time on the user machine?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that a trexio.h file needs to be found to build the rust code. If the code can't be built, the documentation can't be built either.
On the doc.rs website (which hosts the documentation of all rust crates), all the files needed to build the code have to be in the repo. So I added this file as a fallback to be able to build the documentation. Otherwise, the documentation on doc.rs is empty, but the users can build it locally.
It still doesn't work though, because I need to make tests on a machine where trexio is not installed....
Do you know how I could generate the documentation on doc.rs easily?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scemama No, sorry, my Rust is still at the very basics. Is there a way to tell doc.rs to go and download the release tarball from Github before building the documentation? We have trexio.h there..

@scemama scemama requested a review from q-posev December 8, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants