Keyple API Documentation

Central repository for API documentation of all Eclipse Keyple libraries, including both Java (Javadoc) and C++ (Doxygen) references.

Repository Structure

This repository uses two main branches:

• main: Contains the repository configuration and workflows
• gh-pages: Contains the actual documentation and Jekyll configuration, published at https://docs.keyple.org/

Managing Documentation Sources

Adding a New Library Documentation

To add documentation for a new library:

# Switch to gh-pages branch
git checkout gh-pages

# Add the submodule pointing to the gh-pages branch
git submodule add -b gh-pages https://github.com/eclipse-keyple/[library-name].git [library-name]

# Commit the changes
git add .
git commit -m "feat: add documentation for [library-name]"
git push origin gh-pages

Removing a Library Documentation

To remove documentation for a library:

# Switch to gh-pages branch
git checkout gh-pages

# Remove the submodule
git submodule deinit -f [library-name]
rm -rf .git/modules/[library-name]
git rm -f [library-name]

# Commit the changes
git commit -m "feat: remove documentation for [library-name]"
git push origin gh-pages

Automatic Updates

This repository includes a GitHub Action that automatically updates all submodules to their latest commits. The action:

• Runs on manual trigger, repository dispatch event, or push to gh-pages
• Updates all submodules recursively
• Commits and pushes changes if updates are detected
• Uses a dedicated bot account for commits

You can view the action workflow in /.github/workflows/update-submodules.yml.

Contributing

Please read our contribution guidelines before submitting any changes.

License

This project is licensed under the Eclipse Public License v. 2.0. See LICENSE for details.