libdoc2text

Generate library documentation in plain text from the JSON generated by libdoc.

Use Cases

Markdown documentation to generate a static site with Mkdocs or upload it to Confluence
Asciidoc documentation to generate a static site with Asciidoctor

How to use it

Install the package

pip install robotframework-libdoc2text

Save the desired template to the current directory

For Markdown:

libdoc2text init.md

For Asciidoc:

libdoc2text init.adoc

Hint: In case your environment does not allow executing libdoc2text, call the Python module directly:

python -m Libdoc2Text init.md

Modify the template
Generate the library documentation with libdoc

python -m robot.libdoc Library Library.json

Generate the plain text documentation with libdoc2text

libdoc2text run library.md.jinja Library.json Library.md

How it works

The template files are Jinja templates. When libdoc2text run is executed Jinja processes the template, which results in a Markdown or Asciidoc file.

Metadata

Release files for robotframework-libdoc2text 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotframework-libdoc2text 1.0.1
File	Size	Uploaded	Provenance
robotframework_libdoc2text-1.0.1.tar.gz	2.4 kB	Jan 30, 2024	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for robotframework-libdoc2text 1.0.1
File	Interpreter	ABI	Platform	Reset
robotframework_libdoc2text-1.0.1-py3-none-any.whl 7.9 kB Jan 30, 2024 Without provenance	Python 3	none	any	Details

Total release size: 10.3 kB

Release files / robotframework_libdoc2text-1.0.1.tar.gz

Download URL	robotframework_libdoc2text-1.0.1.tar.gz
Size	2.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`85e3ebb705bc7f85cac80d193b3932169537f20695ae694ce5c07859bcf2cc68`
BLAKE2b-256 checksum How to use checksums	`643e6dd19e625a2577dfbd681fce9f67afbcd4a7aaba70661740a138a726df2b`
Upload date	Jan 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.1`

Release files / robotframework_libdoc2text-1.0.1-py3-none-any.whl

Download URL	robotframework_libdoc2text-1.0.1-py3-none-any.whl
Size	7.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`87a746fdf24e812ebffd5bebf638ddbe9a25a8659ff8f386fff873f3cd9a2945`
BLAKE2b-256 checksum How to use checksums	`a73935427f088733d24b690da09ef8de9b11820ed13cea94ef13b230e764e455`
Upload date	Jan 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.1`

Security for robotframework-libdoc2text 1.0.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.