Skip to main content

A simple and configurable generator for RobotFramework documentation

Project description

RF Documentations Indexer

Rfdocsindexer is a simple Python3 module to generate RobotFramework 4+ libraries documentation.

One can configure the tool from a simple TOML configuration file and run it from a console.

The tool then uses the RobotFramework Libdoc module to generate an HTML, XML, JSON or Libspec documentation for any RobotFramework keyword library.

An HTML index is also generated to centralize the generated documentations.

RFDocsIndexer Diagram

Below is an overview of the HTML index generated. It makes it easy to navigate among external resources and keywords documentation.

Index File Overview

Installing the tool

Install from Pypi:

pip install rfdocsindexer

Configuring the tool

The tool can be configured with a config file in TOML format.

Example configuration file:

[rfdocsindexer]
library_paths = ["**/libraries/*.robot", "my_library.resource"]
library_names = ["MyLibrary", "MyOtherLibary.MyOtherLibrary"]
extra_modules_searchpaths = ["./library_dir"]
external_resources = ["RF homepage | https://robotframework.org/", "http://example.org"]
build_machine_readable_libdoc = true
include_robotframework_resources = true

The configuration file must contain the section [rfdocindexer] and any or none of the following options:

  • library_paths: a list of paths (glob format accepted) to RF resource files (can be *.resource, *.robot, *.spec...)
  • library_names: a list of RF library modules
  • extra_modules_searchpaths: a list of paths to append to PYTHONPATH
  • external_resources: a list of URLs which will be added to the HTML index file, or <name> | <URL>. Useful to include frequently used external resources when developing tests.
  • build_machine_readable_libdoc: whether to generate documentation in XML, JSON and Libspec format. If set to False, only the HTML documenation will be generated. Default is False.
  • include_robotframework_resources: whether to generate documentation for default RobotFramework libraries (BuiltIn, Collection, ...). Default is True.

Running the tool

In a standard shell, run the following:

# To generate documentation for default RobotFramework libraries
indexrfdocs

# To specify the configuration file to use
indexrfdocs -c path/to/configfile.toml

# To specify the output directory (content will not be erased if already existing), default is "rfdocs"
indexrfdocs -o path/to/outdir

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rfdocsindexer-1.3.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

rfdocsindexer-1.3.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file rfdocsindexer-1.3.0.tar.gz.

File metadata

  • Download URL: rfdocsindexer-1.3.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1024-azure

File hashes

Hashes for rfdocsindexer-1.3.0.tar.gz
Algorithm Hash digest
SHA256 8bc8fecb49a63550d88a94ec945588ad323efc99eec2829b962ca053677bf149
MD5 22b62dcf9fad221b393f11d5a9229708
BLAKE2b-256 a42ae064c86ee2f059601e0cc19ae6bbfb3d24b8ec91997a87cd21ec3d658ce1

See more details on using hashes here.

File details

Details for the file rfdocsindexer-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: rfdocsindexer-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1024-azure

File hashes

Hashes for rfdocsindexer-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0458b72f455dd5537accc0d955e2634ec1fcce09474ba2300ef9edb5e2ad45e
MD5 1851b39b966ab79452d1f12041ac5e32
BLAKE2b-256 4027b3fb8f32fd03fbc2dca15c0b68d79d3a5cb026814b4b021da140ea42c803

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page