This patch adds three build scripts for the sr.ht CI:
- archlinux.yml is the main build script. It builds the project using
the latest stable release from rustup and executes the tests, clippy
and rustfmt. The build also runs the reuse tool to check compliance
with the reuse specification and verifies that the last commit is
signed by me.
- archlinux-msrv.yml builds and tests the project on the MSRV, currently
Rust 1.40.0.
Previously, we only supported documentation for modules and top-level
items. With this patch, we also display the documentation for members
of an item, typically methods of a struct or trait.
Previously, we could only print documentation for the items listed in
all.html. With this patch, we also load the documentation for modules
(including crates) from the <module>/index.html file. Note that items
are preferred over modules if there is documentation for both (e. g.
std::u8 is both a module and a primitive).
If the pager terminates before we wrote everything to stdout, we get a
BrokenPipe error. We just want to ignore this error but the print*!
macros panic. Therefore we replace the calls to print*! with calls to
write*! and ignore the BrokenPipe error kind when handling the error.
Previously, we wrapped all lines at 100 characters and just printed to
stdout. With this patch, we use the pager crate to spawn a pager
(typically less) before printing the text. Also, we try to use the
terminal size to determine the line length: The default line length is
still 100 characters but can be reduced to fit the terminal.
Previosuly, the plain text viewer was the default option. But for
interactive use, rich text output would be a more sensible default.
With this patch, we check whether we are called from a TTY to choose the
default viewer: rich for interactive use, text for non-interactive use.
html2text’s PlainDecorator that is used to produce plain text prints all
link targets at the end of a block. While this is generally useful,
listing all local links makes the output hard to read. JavaScript and
Rust plaground links are generally not very useful in this context.
Therefore we implement a custom TextDecorator that only lists external
links (http or https) and ignores links to the Rust playground.
This patch adds a new --viewer command line option that lets the user
select a viewer that displays the documentation. It also adds a default
viewer implementation that uses html2text to generate plain text from
the HTML documentation.
html2text requires the ptr_cast feature and we use the Option::as_deref
method in the viewer implementation, so we have to update the minimum
supported Rust version to 1.40.
This patch adds typical Rust documentation locations to the sources:
- /usr/share/doc/rust{,-doc}/html for the standard library documentation
- ./target/doc for the documentation generated for the current crate
It also adds the --no-default-sources option that disables this
behavior.
This patch adds the parser module that uses kuchiki and html5ever to
parse the HTML documentation.
As kuchiki requires std::mem::MaybeUninit, we have to bump the minimum
supported Rust version to 1.36.
This patch adds the doc and source module with the basic data structures
for the documentation items:
- A Source loads the documentation items from e. g. the file system.
- The documentation items (modules, traits, etc.) are grouped by crates.
It also adds a simple Source implementation, DirSource, that reads the
data from a local directory.
Robin Krahl