Page History

...

Prepare your machine (if needed)

This instructions were tested against an AlmaLinux 9 'clean' machine.

Install Make sure you have git and make to start with:

Code Block
sudo dnf install git make

installed.

The simplest thing, then, is to prepare a (recent) python virtual environment using conda:

...

Code Block
git clone git@github.com:CloudVeneto/CVUserGuide.git cd CVUserGuide python -m pip install -r source/requirements.txt

Info
Please note: you might clone a copy of the documentation using the 'https' protocol but you won't be able to push your changes afterwards. Please be sure you can clone the repo using the 'SSH' protocol as above (e.g. you are entitled to push your commits to the repo).

...

Code Block
cd CVUserGuide make html

Check in a browser build/index.

...

html

The following operations must be done each time it is necessary to update the user guide. They can be done as normal user.

Update the sources from git:

Code Block
$ cd CVUserGuide $ git pull

Make your changes. Also edit the file source/conf.py increasing the last number (the one after the ".") for "release" and "version".

Try to build:

Code Block
make html

Check in a browser build/index.

...

html

If you are happy, commit and push:

...

In that case ensure in .git/config the remote "origin" url is set to

Code Block

language	text

url = git@github.com:CloudVeneto/CVUserGuide.git

and retry.

...