#documentation #sphinx #rustdoc #restructuredtext #comments #extract #executable

bin+lib sphinx-rustdocgen

Executable to extract rustdoc comments for Sphinx

6 releases (breaking)

0.6.1 Aug 28, 2024
0.6.0 Aug 20, 2024
0.5.0 Aug 14, 2024
0.4.0 Jul 11, 2024
0.1.1 Apr 20, 2024

#697 in Development tools

Download history 135/week @ 2024-06-07 29/week @ 2024-06-14 2/week @ 2024-06-21 5/week @ 2024-06-28 54/week @ 2024-07-05 50/week @ 2024-07-12 1/week @ 2024-07-19 7/week @ 2024-07-26 3/week @ 2024-08-02 109/week @ 2024-08-09 180/week @ 2024-08-16 139/week @ 2024-08-23 28/week @ 2024-08-30 14/week @ 2024-09-13

192 downloads per month

GPL-3.0-or-later

200KB
4K SLoC

sphinx-rustdocgen

This crate is a part of the sphinxcontrib-rust project.

Documentation:

Repository: https://gitlab.com/munir0b0t/sphinxcontrib-rust

License: GNU GPLv3 or later


lib.rs:

Library for the sphinx-rustdocgen executable.

It consists of functions to extract content from the AST and to write the content to an RST or MD file. The crate is tested on itself, so all the documentation in the crate is in RST. The tests for Markdown are done on the dependencies.

Dependencies

~1–2MB
~42K SLoC