Commit Graph

3 Commits

Author SHA1 Message Date
Danik Klimuk
38906581c4 Add gitcliff and reuse fix (#633)
* add git-cliff and reuse

Files that do not support comments or that have problems adding comments
at the first line should have a separate .license file or a rule inside
REUSE.toml (in case there are a lot of such files).

.robot files generally support comments at the first line, but robotidy
does not want comments to start at first line. It wants so, that everything
that is located before first section should be placed inside "Comments"
section. But reuse does not support license headers in any sections. So
reuse and robotidy have a conflict here.

Because there are a lot of .robot files, I have decided to add them into
REUSE.toml instead of separate .license files or robotidy exceptions.

Signed-off-by: Daniil Klimuk <daniil.klimuk@3mdeb.com>

* add LICENSES and license headers to files

Files that does not have license headers have either .license file or a
rule inside REUSE.toml.

Signed-off-by: Daniil Klimuk <daniil.klimuk@3mdeb.com>

* .github: ISSUE_TEMPLATE: fix markdownlint

Signed-off-by: Daniil Klimuk <daniil.klimuk@3mdeb.com>

* README: add git-cliff and reuse

Signed-off-by: Daniil Klimuk <daniil.klimuk@3mdeb.com>

---------

Signed-off-by: Daniil Klimuk <daniil.klimuk@3mdeb.com>
2024-12-17 18:49:05 +01:00
Eduard Kaverinskyi
4beb2f17d7 591 duplicate keywords (#596)
- Implement Python script to create concatenated file with all keywords.
- Each keyword is prefixed by the name of the source file.
- Remove logic from the create-docs.sh script, it calls the python one
  instead.
- Update README to show the newest way of generating docs.
---------

Signed-off-by: Eduard Kaverinskyi <eduard.kaverinskyi@3mdeb.com>
2024-11-20 13:51:13 +01:00
WiktorG351
0d66d1d969 Automatically generate Keywoards Documentation using libdoc with CI workflow (#352)
* scripts/create-docs.sh: created

* README.md: add info about libdoc, testdoc and create-docs.sh

* .github/workflows/auto-docs.yml: added

* adressed review

* try to start workflow

* fix paths

* make sure virtual environment gets activated

* modify libdoc command, remove venv activation

* try to make it push html files

* change the documentation file name

* test whether the documentation gets updated

* remove the unnecessary keyword since the deployment works

* README.md: added info about github pages

* README.md: add docs deployment status badge

Signed-off-by: Artur Raglis <artur.raglis@3mdeb.com>

* README.md: fix status badge link

Signed-off-by: Artur Raglis <artur.raglis@3mdeb.com>

---------

Signed-off-by: Artur Raglis <artur.raglis@3mdeb.com>
Co-authored-by: Artur Raglis <artur.raglis@3mdeb.com>
2024-08-13 17:58:43 +02:00