Crate cargo_sync_readme 

Library used to implement the cargo-sync-readme binary.

Modules

intralinks

Tooling to manipulate intralinks by parsing Rust code.

Structs

Manifest

The project manifest.

WithWarnings

An object with warnings accumulated while creating this object.

Enums

FindManifestError

Possible error that might happen while looking for the project manifest.

PreferDocFrom

Preferences from which file the documentation should be taken if both present.

TransformError

Errors that might happen while transforming documentation.

Constants

MANIFEST_NAME

Name of the manifest containing the project metadata.

MARKER_END

End marker in the README file.

MARKER_END_RE

Regular expression to find the end marker.

MARKER_RE

Regular expression to find the initial marker.

MARKER_START

Start marker in the README file.

MARKER_START_RE

Regular expression to find the start marker.

Functions

extract_inner_doc

Open a Rust file and get its main inner documentation (//!), applying filters if needed.

read_readme

Open and read a README file.

transform_readme

Transform a readme and return its content with the documentation injected, if any.