Page History

...

Prepare your machine (if needed)

Make sure you have git and make installed.

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

git clone https://github.com/CloudVeneto/CVUserGuide.git

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
sh ./Miniconda3-latest-Linux-x86_64.sh

 
Then Once activated the 'base' environment or if you created and activated a new one, within the conda environment:

pythongit -m pip install --upgrade --no-cache-dir pip setuptoolsclone git@github.com:CloudVeneto/CVUserGuide.git
cd CVUserGuide
python -m pip install --upgrade --no-cache-dir pillow \
   mock==1.0.1 alabaster>=0.7 commonmark==0.9.1 recommonmark==0.5.0
python -m pip install --exists-action=w --no-cache-dir -r source/requirements.txt
pip install 'sphinx_rtd_theme'r source/requirements.txt

Create your local copy of the documentation

cd CVUserGuide
make html

Check in a browser build/index.html

Update the existing documentation

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

Download Update the sources from git:

$ 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:

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

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

and retry.

...

Related articles

...