Providing TeXInfo output for the documentations, and The Book

documentation
1

TeXInfo is a versatile way of providing package documentations, and is widely across free software projects. TeXInfo can be converted into HTML, or just read read in an info reader, as one that comes with GNU Emacs. It can integrate images, source-code and even animations.

Rust has robust documentation, but as someone who prefers to keep my workflow minimal, I would prefer to not really open a browser to view my necessary documentation. The same is true for accessing The Book locally through rustdoc --book.

TeXInfo can be converted from asciidoc or markdown through pandoc or other means. I think this would benefit people with certain workflows, and in general make our documentation accessible to more people.

For references on implementations of manuals and documentations using TeXInfo, I urge one to look into the documentation of GNU Guix, GNU Emacs, GCC Manuals and so on. They provide documentation in PDF, HTML, ASCII and of course Info.

I am willing to help in the implementation if there is an interest on this.

2

As a maintainer of the book who is already overworked, I am not able to assume maintenance of TeXInfo rendering of the book, but the book is MIT licensed so you can feel free to maintain a separate repo and/or fork providing this.

The book and many other Rust documentation resources are rendered using mdbook, which has a plugin mechanism-- that might be a good way to implement TeXInfo rendering so that anything using mdbook could be rendered to TeXInfo.

5 Likes