documentation is outdated

[nopeppermint]

BASIL documentation on https://basil-the-fusa-spice.readthedocs.io/en/latest/ is not up-to-date with latest main branch.

maybe add a automated update of the documentation in CI?

status of the doc can be seen here https://app.readthedocs.org/projects/basil-the-fusa-spice/builds/?utm_source=basil-the-fusa-spice&utm_content=flyout

[pellecchialuigi]

I'm not sure if the documentation can be automatically updated from the CI.
Actually I'm doing it manually via readthedocs.
Waiting for #80 and #85 to be merged

[nopeppermint]

I'm not sure if the documentation can be automatically updated from the CI.

I have no experience, but it seems there is a possibility with readthedocs:

https://docs.readthedocs.com/platform/stable/continuous-deployment.html

https://docs.readthedocs.com/platform/stable/guides/setup/git-repo-manual.html

[pellecchialuigi]

I don't have permissions actually to set the needed webhook to automate that process.
I updated it manually.

[mrpollo]

Hey @pellecchialuigi I can help with this, do you have a guide on how to build the docs?

[pellecchialuigi]

Hi @mrpollo, first of all thanks for your help!
I build the doc on readthedocs.com using a community account.
documentation is made in sphynx and I build manually using the following command (also available in .pre-commit-config.yaml):

sphinx-build -W docs/source docs/build

I also have a configuration file for it: https://github.com/elisa-tech/BASIL/blob/main/.readthedocs.yaml

Read the doc can build the documentation on each commit and I'm trying to understand if it needs a webhook for it.

that should be the documentation https://docs.readthedocs.com/platform/stable/reference/git-integration.html#github