Skip to content

docs: add the Sphinx documentation#86

Open
dupremathieu wants to merge 2 commits intoseapath:mainfrom
dupremathieu:doc
Open

docs: add the Sphinx documentation#86
dupremathieu wants to merge 2 commits intoseapath:mainfrom
dupremathieu:doc

Conversation

@dupremathieu
Copy link
Member

@dupremathieu dupremathieu commented Mar 9, 2026

Add files to generate API reference and CLI documentation using Sphinx. Update .cqfdrc to add a new flavor for docs generation and the corresponding command.

Update the Dockerfile to include Sphinx and its dependencies for building the documentation.

Copy link
Member

@eroussy eroussy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your commit about importing the VM into cluster is also in this PR. See #85 for review on this commit

Typo on commit message "AQdd"

Otherwise, LGTM

@eroussy
Copy link
Member

eroussy commented Mar 10, 2026

Also, you have four errors when building the docs.

/home/eroussy/temp/vm_manager/vm_manager/vm_manager_libvirt.py:docstring of vm_manager.vm_manager_libvirt.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/vm_manager_cluster.py:docstring of vm_manager.vm_manager_cluster.import_vm:5: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/vm_manager_cluster.py:docstring of vm_manager.vm_manager_cluster.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/helpers/libvirt.py:docstring of vm_manager.helpers.libvirt.LibVirtManager.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/helpers/pacemaker.py:docstring of vm_manager.helpers.pacemaker.Pacemaker.find_resource:4: ERROR: Unexpected indentation. [docutils]

@eroussy
Copy link
Member

eroussy commented Mar 10, 2026

And finally, once we merge that, it would be cool to document it on the wiki : https://lf-energy.atlassian.net/wiki/spaces/SEAP/pages/533856287/The+vm_manager+tool

@dupremathieu
Copy link
Member Author

Also, you have four errors when building the docs.

/home/eroussy/temp/vm_manager/vm_manager/vm_manager_libvirt.py:docstring of vm_manager.vm_manager_libvirt.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/vm_manager_cluster.py:docstring of vm_manager.vm_manager_cluster.import_vm:5: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/vm_manager_cluster.py:docstring of vm_manager.vm_manager_cluster.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/helpers/libvirt.py:docstring of vm_manager.helpers.libvirt.LibVirtManager.status:4: ERROR: Unexpected indentation. [docutils]
/home/eroussy/temp/vm_manager/vm_manager/helpers/pacemaker.py:docstring of vm_manager.helpers.pacemaker.Pacemaker.find_resource:4: ERROR: Unexpected indentation. [docutils]

Fixed

Add files to generate API reference and CLI documentation using Sphinx.
Update .cqfdrc to add a new flavor for docs generation and the
corresponding command.

Update the Dockerfile to include Sphinx and its dependencies for
building the documentation.

Signed-off-by: Mathieu Dupré <mathieu.dupre@savoirfairelinux.com>
Signed-off-by: Mathieu Dupré <mathieu.dupre@savoirfairelinux.com>
@dupremathieu
Copy link
Member Author

Your commit about importing the VM into cluster is also in this PR. See #85 for review on this commit

Typo on commit message "AQdd"

Typo on commit message "AQdd"

Fixed

@sonarqubecloud
Copy link

@dupremathieu
Copy link
Member Author

@dupremathieu dupremathieu requested a review from eroussy March 10, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants