diff --git a/.github/workflows/generate_docs.yml b/.github/workflows/generate_docs.yml index 4bc5f6d..9eccb17 100644 --- a/.github/workflows/generate_docs.yml +++ b/.github/workflows/generate_docs.yml @@ -19,7 +19,7 @@ jobs: # with: # python-version: '3.x' - name: Install requirements - run: pip install . + run: pip install .[all] - name: Generate keyword documentation run: python3 -m robot.libdoc -f html src/ConfluentKafkaLibrary docs/index.html - uses: stefanzweifel/git-auto-commit-action@v5 diff --git a/README.md b/README.md index a23cbef..4045dd6 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,12 @@ pip install robotframework-confluentkafkalibrary ``` Extra packages: -* [avro] = ['fastavro >= 1.3.2', 'avro >= 1.11.1'] -* [json] = ['jsonschema >= 3.2.0'] -* [protobuf] = ['protobuf >= 4.22.0'] -* [schemaregistry] = ['httpx>=0.26', 'cachetools >= 5.5.0', 'attrs >= 24.3.0'] -To install all dependencies use `[all]` extension like: +* `[avro]` = `['fastavro >= 1.3.2', 'avro >= 1.11.1']` +* `[json]` = `['jsonschema >= 3.2.0', 'pyrsistent >= 0.20.0']` +* `[protobuf]` = `['protobuf >= 4.22.0', 'googleapis-common-protos >= 1.66.0']` +* `[schemaregistry]` = `['httpx>=0.26', 'cachetools >= 5.5.0', 'attrs >= 24.3.0']` + +* To install all dependencies use `[all]` extension like: ``` pip install robotframework-confluentkafkalibrary[all] diff --git a/docs/index.html b/docs/index.html index 1d9ff52..e5f91ed 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,1876 +1,410 @@ - + - - - - - - - - - - - - - + + + + + + + - - - - - - - - - -

Opening library documentation failed

Verify that you have JavaScript enabled in your browser.
Make sure you are using a modern enough browser. If using Internet Explorer, version 11 is required.
Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.

- - - - - modalBackground.classList.remove('visible'); - modal.classList.remove('visible'); - document.body.style.overflow = 'auto'; - if (window.location.hash.indexOf('#type-') == 0) - history.pushState("", document.title, window.location.pathname); - // modal is hidden with a fading transition, timeout prevents premature emptying of modal - setTimeout(() => { - modalContent.innerHTML = ''; - }, 200); - } + + + + - // http://stackoverflow.com/a/18484799 - var delay = (function () { - var timer = 0; - return function(callback, ms) { - clearTimeout(timer); - timer = setTimeout(callback, ms); - }; - })(); - - - - - + + + + + + - - - - - - - + + + + - - + + - - - - - - - - - - - - + {{#if usages.length}} +

{{this}}

+ {{/if}} + + + + + +

Opening library documentation failed

{{t "usages"}}