Sphinx Documentation and Deploymment

[Xeratec]

Changelog

This pull request introduces a GitHub Actions workflow for automatically building and publishing Sphinx-based documentation. The workflow triggers on every push or pull request and ensures consistent generation and deployment of project documentation.

The documentation is built using Sphinx, with integration of Doxygen to extract inline documentation from C source code. The Doxygen output is then parsed and incorporated into the Sphinx build using the Breathe plugin, allowing seamless inclusion of API documentation within the overall project documentation.

The workflow supports multi-branch GitHub Pages, enabling documentation for different branches to be deployed side-by-side. This allows maintaining documentation for various development stages (e.g., main, feature branches, and PR-specific previews). Each branch’s documentation is hosted under its respective path. For example:

• The default branch (master) is deployed to the root of the GitHub Pages site.
  (e.g. https://pulp-platform.github.io/chimera-sdk/)
• Other branches, such as feature branches, are deployed under sub-paths corresponding to their branch names.
  (e.g. https://pulp-platform.github.io/chimera-sdk/branch/devel)

An example documentation for this branch can be previewed here.

Added

• New GitHub Actions workflow file: .github/workflows/docs.yml.
• Automation for:
  • Installing dependencies.
  • Building the documentation using Sphinx.
  • Publishing the generated documentation as GitHub Pages.
• First draft of documentation
• Enable linting of Python files

Changed

• Removed redundant information in README.md to avoid duplication and divergence.
• Autoformatting of python files

[Scheremo]

LGTM!

[Scheremo]

I personally like autodoc and napoleon - maybe for a later iteration :)

[Xeratec]

I also like it a lot but as there is not really Python code for now, I disabled it for the moment. Happy to change if there is Phython code that requires documentation.