docs.pelican.bernatchez.net

Configurer un nouveau site Bunny

2026-05-09T12:59:29+00:00

Exemple d'étapes pour configurer votre compte bunny.net afin d'accueillir un nouveau site.

Dans cet exemple, notre nouveau site s'appelle : dummy.example.net

Modifiez les noms selon le nom de votre site.

Connectez-vous à votre compte bunny.net à l'adresse : https://dash.bunny.net/
Créez une zone de stockage standard nommée : dummy-example-net [1]

[1]	L'image montre « docs-pelican-bernatchez-net », devrait afficher « dummy-example-net »

Créez une zone de tirage nommée : dummy-example-net-zone [2]

[2]	Affiche « docs-pelican-bernatchez-net-zone », devrait afficher « dummy-example-net-zone »

Connectez-vous à votre compte de service DNS.
Sur votre serveur DNS, créez un enregistrement : dummy.example.net CNAME dummy-example-net-zone.b-cdn.net
De retour sur bunny.net, ajoutez un nom d'hôte personnalisé dummy.example.net à la zone de tirage [3]

[3]	Affiche « docs.pelican.bernatchez.net », devrait afficher « dummy.example.net »

Lors de cet ajout, profitez-en pour confirmer que le certificat fonctionne correctement.

Votre site est maintenant prêt à être servi. Vous pouvez y publier du contenu.

Tout faire tenir sur une page

2026-04-26T01:36:19+00:00

Mes recettes se composent d'une image et des instructions pour la préparer en dessous. Pour l'impression en format « .pdf », j'essaie de tout faire tenir sur une seule page. Cela signifie que je dois garder l'image petite.

En pratique, je prends une photo avec mon téléphone portable. Ensuite, je l'ouvre avec la visionneuse Shotwell et je recadre la partie qui m'intéresse.

Ensuite, quelle que soit l'image obtenue, je la réduis à environ 1000 pixels de large.

commande de réduction

convert original.jpg -resize 1000x pagefit.jpg

extrait qui inclut l'image dans la source RST

|

.. image:: ../images/pagefit.jpg
    :class: img-responsive
    :scale: 30%
    :alt: Le résultat

J'ai inclus une telle image ci-dessus à titre d'illustration.

Création d'un site .rst

2026-04-16T01:47:25+00:00

Nous parcourons le processus de création d'un nouveau sous-répertoire de site dans notre dépôt git afin de documenter les étapes de démarrage d'un nouveau site.

Ceci ne couvre pas la création réelle de l'infrastructure d'hébergement dans bunny.net. Nous ne passons donc par aucune étape relative à la publication dans cet exemple.

mypelican_static_sites est le projet de dépôt git où nous le configurons.

Nous créons un nouveau site appelé : dummy.bernatchez.net

Créer le nouveau répertoire du site et le peupler

# créer
cd ${HOME}/repos/mypelican_static_sites
mkdir dummy.bernatchez.net

# peupler
cp -r -P init.files/* dummy.bernatchez.net/

Ajouter ces nouveaux fichiers propres au site au contrôle de révision git

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net
# les ajouts git sont à déterminer

Référencer les articles pelican/ préexistants dans notre site factice

Il suffit que le répertoire existe sous content/ pour cela. Le Makefile se charge de peupler le sous-répertoire.

Nous allons ajouter un fichier placeholder.txt dans ce répertoire afin que git clone crée le sous-répertoire à l'avenir.

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net
mkdir content/pelican

# ceci assure que le répertoire pelican/ sera créé lors des futurs git clone
cp content/pages/placeholder.txt content/pelican/placeholder.txt
git add content/pelican/placeholder.txt

Ajouter les lignes suivantes à la fin de « .gitignore »

cd ${HOME}/repos/mypelican_static_sites

cat >>.gitignore <<EOFGITIGNORE
##
## BEGIN added for a new site
##

# dummy.bernatchez.net softlinks

dummy.bernatchez.net/content/favicon.ico
dummy.bernatchez.net/content/images/
dummy.bernatchez.net/content/site-only/
dummy.bernatchez.net/content/pages/
dummy.bernatchez.net/content/pelican/

dummy.bernatchez.net/content/images/*
dummy.bernatchez.net/content/site-only/*
dummy.bernatchez.net/content/pages/*
dummy.bernatchez.net/content/pelican/*


# dummy.bernatchez.net bucket is all generated
dummy.bernatchez.net/bucket/
dummy.bernatchez.net/bucket/*

##
## END additions for a new site
##
EOFGITIGNORE

cd ${HOME}/repos/mypelican_static_sites
git add .gitignore

Placer les fichiers personnalisables sous contrôle de version

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net

git add Makefile
git add deploy.bunny
git add favicon.ico
git add login.bunny
git add names.bunny
git add notes.txt
git add pelicanconf-en.py
git add pelicanconf-es.py
git add pelicanconf-fr.py
git add publishconf-en.py
git add publishconf-es.py
git add publishconf-fr.py
git add purge.bunny
git add puta2p.sh

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/pages
git add *.rst

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/content
git add binaries images sitepdfs

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/pages-media
git add *
cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/pages-pdfs
git add placeholder.txt
cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/site-only-pdfs
git add placeholder.txt
cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/site-only
git add *.rst

# Valider vos ajouts git

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/
git commit -m new-dummy-site

Générer cette première révision du site

cd ${HOME}/repos/mypelican_static_sites/dummy.bernatchez.net/
make html

# réviser et continuer la maintenance selon les besoins

Message de bienvenue

2026-03-22T00:38:24+00:00

Bienvenue sur ce site.

Ce site a pour but de fournir, avec de la documentation, un soutien à toute personne assurant la maintenance du code source des sites web générés par Pelican contenus dans notre dépôt git. Ce site est destiné à ne pas être publié et à être consulté uniquement depuis le système de fichiers local.

Contacts

2026-03-22T00:34:39+00:00

Veuillez adresser toutes vos questions à l'administrateur actuel du site.

Administrateur Actuel Du Site

pierre@bernatchez.net

À propos

2026-03-22T00:29:07+00:00

Version du site

2026-05-10T00:29:55+00:00

Description

Ce site est organisé comme un blog. Les articles les plus récents apparaissent sur la page d'accueil.

Structure

Il y a quatre méthodes pour trouver des articles.

La page d'accueil répertorie les articles les plus récents par ordre chronologique.
Les catégories regroupent les articles par catégorie.
Les mots-clés regroupent les articles par mot-clé.
Les archives présentent un tableau de tous les articles par ordre chronologique.

Comment créer des correctifs de fichiers (patch)

2025-05-24T18:23:52+00:00

Un seul Fichier

Voici comment créer un fichier correctif que vous appliquerez ensuite sur un système cible pour modifier l'un de ses fichiers.

Obtenir la copie originale

cp /pathtofile/myfile.conf /pathtofile/myfile.conf.orig

Modifier le fichier manuellement

À l’aide de n’importe quel éditeur, apportez manuellement les modifications souhaitées au fichier /pathtofile/myfile.conf.

Capturez la différence dans un patch

diff -u /pathtofile/myfile.conf.orig /pathtofile/myfile.conf >myfile.patch

Essayez le patch

Annulez les modifications manuelles que vous avez apportées.

patch -R -p0 <myfile.patch

Refaites vos modifications.

patch -p0 <myfile.patch

Répertoire récursif

Dans cet exemple, nous regroupons toutes les modifications apportées à une arborescence de thèmes Pelican dans un seul fichier correctif.

Dupliquer

Nous commençons par dupliquer l’arbre complet.

cp -r ${HOME}/pelican-themes ${HOME}/pelican-themes.orig

CONSEIL

J'ai tendance à conserver ma copie originale et à la réutiliser fréquemment lorsque je modifie des éléments. Pour éviter de modifier par inadvertance quelque chose dans la version originale et de compromettre ainsi toutes les modifications ultérieures, j'aime protéger les fichiers .orig.

Ce n'est pas indispensable, mais cela m'a bien servi.

chmod -w --recursive pelican-themes.orig/

Créer un fichier de correctif

Nous effectuons maintenant toutes les modifications souhaitées dans le répertoire pelican-themes. Une fois cela fait, nous créons le fichier patch intégrant toutes les modifications.

cd ${HOME}/pelican-themes
diff -Naru ../pelican-themes.orig . > ../pelican-themes.patch

Note:

-N --new-fil traiter les fichiers absents comme vides

-a --text traiter tous les fichiers comme du texte

-r --recursive comparer récursivement les sous-répertoires

-u -U --unified[=NUM] Émettre NUM lignes de contexte unifié (par défaut 3)

Annuler les modifications

cd ${HOME}/pelican-themes
patch -Rs -p0 < ${HOME}/pelican-themes.patch

Note:

N'oubliez pas que les répertoires créés par patch doivent être supprimés manuellement.

-R --reverse Supposons que le patch a été créé avec les anciens et les nouveaux fichiers échangés

-s --silent Silencieusement

-pN Supprimez le plus petit préfixe de fichier contenant N barres obliques. 0 signifie préfixe complet.

Appliquer les modifications du correctif

cd ${HOME}/pelican-themes
patch -s -p0 < ${HOME}/pelican-themes.patch

Configurer un index de package privé de projet

2025-05-24T18:23:52+00:00

Aperçu

Ce document décrit la configuration d'un index de package privé comme un moyen plus pratique de distribuer des packages Python.

La nécessité d'utiliser quelque chose comme celle-ci se développe à mesure que nous ajoutons des mainteneurs et des packages à maintenir.

Nos packages Python doivent être compatisés avec l'index de package Python standard PYPI.

Nous utilisons un index de packages privé jusqu'à ce que nous soyons prêts à mettre un colis à la disposition du grand public, Ensuite, nous passons à PYPI.

Cet outil que nous utilisons maintient nos packages compatibles avec PYPI lorsque nous le mettons à la disposition là-bas.

devpi

Il s'agit d'un système d'index de package conforme.

Nous l'utiliserons pour servir notre index de package privé.

Configuration du SW pour DevPI

Ce howto est dérivé du tutoriel suivant:

<https://devpi.net/docs/devpi/devpi/stable/+doc/quickstart-releaseprocess.html> _

Nous travaillons avec Python3. Nous voulons configurer un environnement virtuel conforme à nos hypothèses, puis installer à l'intérieur. Nous appelons l'environnement devpi_venv. Nous créons d'abord un répertoire pour notre configuration.

mkdir ${HOME}/devpi_setup
cd ${HOME}/devpi_setup

Nous installons les éléments essentiels nus.

python3 -m venv devpi_venv
source devpi_venv/bin/activate
python -m pip install -U pip
pip install wheel
pip install setuptools
pip install twine

RESTVIEW est une visionneuse de format de texte restructuré que je trouve utile.(facultatif)

pip install restview

Vous l'invoquez et il continue de réintégrer votre fichier lorsque vous le modifiez.

Comme ça:

restview README.rst

rst2pdf est pratique pour générer des copies PDF de documants.

pip install rst2pdf
rst2pdf doc/privatepypi.rst -o reformatted_docs/privatepypi.pdf

Configurez le serveur DevPI sur notre ordinateur portable

Installez le client et le serveur Web DevPI Le serveur non Web - DevPI-Server - est installé en conséquence.

pip install -U devpi-web devpi-client

Initialiser un index vide (AT / var / devpi-serveur par défaut) Remarque J'ai eu un problème d'autorisation avec celui init. Alors d'abord je fais manuellement ceci:

sudo mkdir  /var/devpi-server
sudo chown ubuntu:ubuntu /var/devpi-server

devpi-init

Nous voulons un fichier de configuration pour le démon de superviseur à utiliser. Cela générera un tas de fichiers de configuration sous le courant Répertoire, celui que nous voulons inclus.

cd ${HOME}/devpi_setup
devpi-gen-config

Cela nous donne le fichier gen-config / supervisor-devpi.conf pour copier sur / etc / superviseur / conf pour que nous puissions commencer augmentez le serveur.J'ai commencé par le modifier pour dire start = false pour qu'il devrait être démarré Up manuellement.Ensuite, je l'ai copié au bon endroit pour cela.

sudo cp gen-config/supervisor-devpi.conf /etc/supervisor/conf.d/devpi-server.conf
sudo supervisorctl update
sudo supervisorctl start devpi-server

Créez un utilisateur, connectez-vous comme lui et créez l'index 'dev'

devpi user -c pbernatchez password=foobar
devpi login pbernatchez --password=foobar
devpi index -c dev bases=root/pypi

Utilisez notre index de développement

devpi use testuser/dev

Nous pouvons désormais uriliaer l'index privé.

Nous utilisons Flit pour publier sur notre index et repose sur le fichier: ~ / .pypirc.

Nous y faisons donc une entrée pour notre index.Je lui ai donné le nom «myPyPi»:

[distutils]
index-servers =
   mypypi
   testpypi

[mypypi]
repository = http://localhost:3141/pbernatchez/dev
username = pbernatchez

[testpypi]
repository = https://test.pypi.org/legacy/
username = pbernatchez

À partir de maintenant, en utilisant Flit, nous pouvons le désigner «myPyPi».

deactivate
cd /home/ubuntu/allrepos/animbboard
source ${HOME}/venv_animbboard/bin/activate
flit build
flit publish --repository mypypi
pip uninstall  animbboard
pip install -i http://localhost:3141/pbernatchez/dev  animbboard

Set up a private package index

2025-05-24T18:23:52+00:00

Overview

At this writing our current practise is to generate versioned tarballs and to 'pip install' from those.

This describes setting up a private package index as a more convenient alternative to using tarballs directly.

Our python software needs to be kept compatible with the standard python package index for when we desire to offer it to the general public.

To ensure we are staying compatible with pypi, we need to run it through the process, but with a conforming private packaging index.

devpi to the rescue ('https://www.devpi.net/') .

It is a conforming package index system we can use to serve our private packages whithout releasing them to the public.

Configuring the SW for devpi

This information is derived from the following tutorial:

<https://devpi.net/docs/devpi/devpi/stable/+doc/quickstart-releaseprocess.html>_

We start by creating a virtual environment called "venv_devpi" by following the steps described in the document virtualenv.

Then we activate that environment and continue with the steps below.

Set up devpi server on our laptop

Install a devpi client and web server
pip install -U devpi-web devpi-client
Note:
The non-web server - devpi-server - is also installed as a side effect.
We must avoid needing sudo to access the index, so instead we change ownership from root to the logged in user. We also need to make sure supervisor runs our server as that user.

First manually do this:
sudo mkdir -p /var/devpi-server
sudo chown -R $(logname):$(logname) /var/devpi-server
ls -ld /var/devpi-server
Initialize an empty index (at /var/devpi-server by default)
devpi-init
Make a place to put our configuration data files:
mkdir -p ${HOME}/devpi_setup
The following will generate a bunch of config files, one of which we will need, under the current directory. Putting that stuff in ${HOME}/devpi_setup.
pushd . >/dev/null
cd ${HOME}/devpi_setup
devpi-gen-config
popd  >/dev/null
Note:
This gave us the file  ${HOME}/devpi_setup/gen-config/supervisor-devpi.conf
as a config file to start up our pypi server.  Start by editing
it manually to say autostart=False so that it will need to be
started up manually.
Append a line like "user = username" to the configuration so it launches as that user, the same user as above.
echo user = $(logname) >>${HOME}/devpi_setup/gen-config/supervisor-devpi.conf
Copy the config where where it needs to be, then start our server.
sudo cp ${HOME}/devpi_setup/gen-config/supervisor-devpi.conf /etc/supervisor/conf.d/supervisor-devpi.conf
sudo supervisorctl update
sudo supervisorctl start devpi-server
Create a user (within the server), login as that user and create the 'bzdev' index
devpi use http://localhost:3141
devpi user -c pbernatchez password=dummy
devpi login pbernatchez --password=dummy
devpi index -c bzdev bases=root/pypi
Use our bzdev index
devpi use pbernatchez/bzdev
Now we can make use of our private index.

We are using flit to publish to our index and it relies on the file : ~/.pypirc.

For pip I named it 'bzdevpi'. So we make an entry there for our index:
[distutils]
index-servers =
   bzdevpi
   testpypi

[bzdevpi]
repository = http://localhost:3141/pbernatchez/bzdev
username = pbernatchez

[testpypi]
repository = https://test.pypi.org/legacy/
username = pbernatchez
From here on, using flit,

To publish,

flit publish --repository bzdevpi

To install,

pip install -i http://localhost:3141/pbernatchez/bzdev foobar

Example:
deactivate
cd /home/ubuntu/allrepos/wait_ssh
source ${HOME}/venv_generic/bin/activate
flit build
flit publish --repository bzdevpi
pip uninstall wait_ssh
pip install -i http://localhost:3141/pbernatchez/bzdev wait_ssh

Configurer un environnement virtuel python

2025-05-24T18:23:52+00:00

Assurez-vous que la version du système Ubuntu est suffisamment récente

lsb_release -a

Résultat

Distributor ID:     Ubuntu

Description:        Ubuntu 24.04.3 LTS

Release:            24.04

Codename:           noble

python3 -V

Résultat

::: Python 3.12.3

Créer une base pour tous nos environnements virtuels

mkdir ${HOME}/.venv
# Nous pouvons maintenant créer tous nos environnements virtuels sous ${HOME}/.venv/

Créer un environnement virtuel Python

# Ici, nous appelons notre premier environnement devpi
cd ${HOME}/.venv/
python3 -m venv devpi

OU en utilisant venvwrapper

mkvenv devpi

Une fois notre environnement créé, on peut installer les éléments nécessaires pour commencer.

Activez-le

source ${HOME}/.venv/devpi/bin/activate

OU en utilisant venvwrapper

venv devpi

Installer les bases

# installer
python -m pip install -U pip
pip install wheel
pip install setuptools
pip install twine
pip install rst2pdf
pip install flit

# désactiver
deactivate

Garder les pré-requis

Une fois votre environnement virtuel terminé, il est conseillé d'enregistrer le contexte. On peut ensuite restaurer rapidement l´environnement virtuel à partir de zéro si nécessaire.

Pendant actif

pip freeze >requirements.txt

# It may be a good idea to keep such files under version control.

Recupérer

Pendant actif

pip install -r requirements.txt

Activation Automatique

Souvent nous souhaitons activer un projet à chaque connexion. Nous pouvons le faire automatiquement en ajoutant un élément come ceci à .bashrc et/ou à .profile.

#
# Ajouté pour activation automatique de l´environment virtuel.
#
if [ -f "${HOME}/.venv/devpi/bin/activate" ] ; then
    source ${HOME}/.venv/devpi/bin/activate
fi

OU en utilisant venvwrapper

#
# Ajouté pour activation automatique de l´environment virtuel.
#
VENV_HOME=${HOME}/.venv
venv_wrapper=$(which venvwrapper.sh)
if [[ -n $venv_wrapper ]]; then
    source $venv_wrapper
    venv devpi
fi

python virtual environment

2025-05-24T18:23:52+00:00

Python Virtual Environment Setup

To have a good control over pre-requisite library modules for our software, we run in a python virtual environment.

That means that whenever you want to use or maintain the software you must first activate that virtual environment like this: (replace 'generic' with an existing project environment name)

source ${HOME}/venv_generic/bin/activate

Once active you can deactivate it like this:

deactivate

Installation

We install any non pip packages we rely on, if any, first. Then we install virtualenv. Then we create a virtual environment. Then we activate it.

Install virtualenv itself.

sudo apt update
sudo apt install virtualenv

Install a .rst to .pdf converter.

snap install rst2pdf

Create a virtual environment for the project

virtualenv --prompt venv_generic ${HOME}/venv_generic

Then activate the created environment

source ${HOME}/venv_generic/bin/activate

Now we install modules our project will need, first pip itself and the tools it needs.

python3 -m pip install -U pip
pip install wheel
pip install setuptools
pip install twine

We are using flit for building and installling our software.

pip install flit

Saving prerequisites

We keep our dependencies under version control, so each time we install more components we need to refresh our requirements file.

pip freeze >${HOME}/allrepos/generic/requirements.txt

Reinstalling

Later, when we are migrating to a different workstation, or for some reason need to restablish our project from scratch, we can install all our prerequisites in one shot instead of installing items one at a time like we did above.

pip install -r ${HOME}/allrepos/generic/requirements.txt

Automatic activation

In many cases we want to activate a project whenver we log in, so lets do that automatically.

Append this snippet to the end of our "${HOME}/.bashrc" file.

#
# Added for automatic vitual environment activation
#
if [ -f "${HOME}/venv_generic/bin/activate" ] ; then
    source ${HOME}/venv_generic/bin/activate
fi

Good ignoring keeps flit happy

Flit works nicely with git, but it is quite strict, so we must ignore all irrelevant files properly or flit will reject builds.

Below is a good start for a project ".gitignore" file:

*~
\#*\#
dist/*
pdf_docs/*
html_docs/*

Set Up A Wrapper For Venv Environments

2025-05-24T18:23:52+00:00

To maintain more than one python project at a time we leverage the the builtin python venv tool for creating and using virtual environments.

The venvwrapper package helps to keep the maintenance of multiple virtual environments easier. In short venv is enough, but venvwrapper makes it easier.

Installation

Install the venvwrapper package into your default system Python 3. That is, with no virtual environment active. This installs venvwrapper.sh so that it is available in PATH

sudo pip3 install --break-system-packages venvwrapper

Check that it is indeed available

which venvwrapper.sh

Set up automatic activation of venvwrapper

Add the code snippet below to one or both of these two files.

${HOME}/.bashrc
${HOME}/.profile

Code snippet:

VENV_HOME=${HOME}/.venv
venv_wrapper=$(which venvwrapper.sh)
if [[ -n ${venv_wrapper} ]]; then
    source ${venv_wrapper}
fi

Now Once you open a terminal window you have access to these commands

mkvenv devpi  # create and activate a new virtual environment
venv   devpi  # activate an existing virtual environment
rmvenv devpi  # remove one or more virtual environments
lsvenv        # list existing virtual environments

Attributs de métadonnées dans chaque article

2025-04-16T00:37:11+00:00

Pelican a besoin de méta-données comme celles-ci

:lang: fr
:date: 2025-04-16 00:37:11+00:00
:tags: métadonnées, article, pélican
:slug: articlemeta
:category: pelican
:authors: Pierre Bernatchez
:summary: Métadonnées dans les articles

Insérez-les sous la rubrique initiale de chaque article.

Celles-ci devraient être identiques dans toutes les traductions d'un article.

:date: 2025-04-16 00:37:11+00:00
:slug: sitehome
:authors: Nuno Yobidness

Celles-ci doivent être traduites dans les différentes versions linguistiques de l'article.

:lang: fr
:tags: introduction
:category: pelican
:summary: Bienvenue sur le site

Ces options sont facultatives.

Cela empêche le contenu d'apparaître dans les menus, pages, mots-clés et catégories. Il sera généré, mais vous aurez besoin d'un lien quelque part pour y accéder. Utilisez la même valeur dans toutes les langues.

:status: hidden

Cela remplace le pied de page de droits d'auteur par défaut. La valeur dépend de la langue.

:fcopyright: Droits d´auteur © 2026 Isaac Mejia—Tous droits reservés.

projet git mypelican_static_sites

2025-04-16T00:37:11+00:00

Vue d'ensemble

Il s'agit d'un projet github qui utilise un générateur de sites appelé pelican pour générer des sites web statiques.

Au moment de la rédaction, ce projet maintient le contenu et la génération pour trois sites distincts. Chaque site est rendu en 3 langues : anglais, français et espagnol.

Par convention, nous nommons chacun de ces sous-répertoires en utilisant le nom de domaine du site. Les scripts s'appuient sur cette convention.

Sites actuellement maintenus

www.bernatchez.net

Hébergé sur Bunny.net : www-bernatchez-net
www.ogopogo.biz

Hébergé sur Bunny.net : www-ogopogo-biz
blog.bernatchez.net

Hébergé sur Bunny.net : blog-bernatchez-net
docs.pelican.bernatchez.net

Hébergé non publié sur le système de fichiers local.

Génération du site web

Générez une version locale d'un site afin de pouvoir le parcourir et le vérifier avant de le publier.

cd ./blog.bernatchez.net
make html
xdg-open ./bucket/index.html
cd ..

Générez une version en ligne du site et publiez-la.

cd ./blog.bernatchez.net
# Assurez-vous que le fichier deploy.bunny exécute réellement une commande "nmx" plutôt que de simplement l'afficher.
make pubhtml

# Invoquez manuellement la commande affichée en dernière ligne par le make ci-dessus
# Cela pousse tout vers le cache CDN
npx --yes bunny-transfer@latest purge blog-bernatchez-net-zone

Avertissement

Une fois que vous avez invoqué « make pubhtml », le contenu de votre « site local » ne sera plus approprié pour une consultation locale. Si vous souhaitez parcourir les versions locale et en ligne de façon interchangeable, vous devez répéter la commande « make html » après la publication, laissant ainsi les fichiers locaux configurés pour une consultation locale.

Maintenance du site web

Portée

Le projet git est organisé avec 2 portées pour le contenu source du site.

*Portée source globale*

   Les fichiers .rst contenus dans les sous-répertoires du répertoire principal du projet.
   Ces fichiers peuvent être utilisés comme source par n'importe lequel de nos sites web.

*Portée source locale*

   Les fichiers .rst contenus dans les sous-répertoires d'un sous-répertoire de site donné.
   Ces fichiers ne peuvent être utilisés comme source que par le site web concerné.

Le sous-répertoire « content » d'un site donné contient des sous-répertoires dont
les noms correspondent aux sous-répertoires de portée globale ou locale. Cela
détermine ce qui sera inclus dans le site.

Les noms de répertoires présents dans le répertoire « content » déterminent
ce qui est inclus dans le site généré.

Le fichier make se charge de peupler ces répertoires avec des liens
symboliques vers les fichiers source .rst dans leurs répertoires de portée
locale ou globale correspondants.

En ce qui concerne le dépôt, vous ne faites « git add » que pour les fichiers .rst
situés dans les répertoires de portée globale ou locale. Les
sous-répertoires sous content/ ne contiendront qu'un fichier « placeholder.txt »
dans git pour s'assurer que leurs sous-répertoires seront créés lors du
clonage.

Source pdf

Tous nos sites contiennent également des versions .pdf de leurs pages. Pour
produire ces fichiers pdf, chaque répertoire source contient deux
fichiers de script exécutables : **article2pdf** et **qarticle2pdf**.
Ce dernier est simplement une version moins verbeuse. Chaque fois que vous modifiez ou
ajoutez du contenu dans un répertoire source, pensez à régénérer les
fichiers .pdf en conséquence.

En général, vous modifiez votre contenu, puis invoquez « qarticle2pdf »
pour vous assurer que vos pdfs sont à jour.

Si vous avez créé un nouveau répertoire source, vous pouvez générer ces deux scripts
en invoquant la commande « genarticle2pdf -q » à l'intérieur du nouveau répertoire.

Maintenance github

Lorsque vous clonez le projet github dans un répertoire local, vous obtenez
un répertoire principal qui contient des sous-répertoires de sites web, chacun
d'entre eux étant un répertoire de génération de site web indépendant.

Le répertoire principal du projet contient divers sous-répertoires de *portée source globale*
(ex. : ./examples, ./artwork, ./travel,
etc.). Chacun d'eux contient des fichiers .rst pouvant servir de source
pour la génération du contenu du site. Tous sous contrôle de révision git.

Ce contenu de *portée source globale* peut optionnellement être utilisé comme source
pour n'importe lequel des sites web.

Chaque sous-répertoire de site web peut également contenir ses propres sous-répertoires
contenant des fichiers .rst de *portée source locale* spécifiques au site
(ex. : ./blog.bernatchez.net/pages/) destinés uniquement au site
concerné.

Pour ajouter l'un de ces répertoires de contenu à *portée locale ou globale*
à un site web donné, vous devez créer un répertoire du même
nom sous le sous-répertoire content du site concerné. Vous devez également
ajouter un fichier « placeholder.txt » et le mettre sous contrôle de révision
(ex. : git add placeholder.txt) pour s'assurer que ce nouveau répertoire sera
créé lors de l'utilisation de « git clone ».

Par exemple, nous avons procédé ainsi pour ajouter ./examples au site web ./blog.bernatchez.net :

mkdir ./blog.bernatchez.net/content/examples/
cp ./blog.bernatchez.net/content/pages/placeholder.txt ./blog.bernatchez.net/content/examples/
git add ./blog.bernatchez.net/content/examples/placeholder.txt

Vous devez également modifier le fichier .gitignore du projet pour éviter d'ajouter
les liens symboliques générés sous content/examples dans le dépôt git.
Ces liens sont régénérés à chaque make.

Nous avons ajouté les lignes suivantes au fichier .gitignore :

blog.bernatchez.net/content/examples/
blog.bernatchez.net/content/examples/*

Dépôt

La copie centrale originale du dépôt de ce projet est :

git@github.com:pierrebernatchez/mypelican_static_sites.git

Point de départ d'un article

2024-12-06T20:05:03+00:00

Contenu RST d'exemple pour servir de base et être modifié pour votre article.

En-tête principal de votre article
#############################################

:lang: fr
:category: une catégorie valide
:date: 2025-10-11 20:03:36+00:00
:tags: article, modèle
:slug: nom-unique-de-l-article
:authors: Pierre Bernatchez
:summary: Résumé en une ligne de votre article

.. |copy| unicode:: 0xA9 .. signe copyright

.. |---| unicode:: U+02014 .. tiret cadratin
   :trim:

.. footer:: Copyright |copy| 2025 Pierre Bernatchez |---| tous droits réservés.


Commencez ici

Modifiez l'en-tête principal par quelque chose de convenable pour votre article.

Modifiez la catégorie par une catégorie appropriée à votre article.

Modifiez la date. Vous pouvez utiliser la commande en ligne de commande "date -u --rfc-3339=seconds" pour obtenir une chaîne de date correctement formatée.

Modifiez les étiquettes avec des mots-clés pertinents pour votre article.

Modifiez le slug pour qu'il soit le nom unique de votre article. Nous l'utilisons comme base pour le nom de fichier du fichier .rst. Ainsi, slugname-en.rst, slugname-es.rst, slugname-fr.rst sont les 3 noms de fichiers en différentes langues pour l'article avec le slug : slugname.

Modifiez authors par votre propre nom.

Modifiez le résumé par quelque chose d'approprié à votre article.

Modifiez également le nom dans la ligne footer par le vôtre.

Rédigez votre article en utilisant le balisage RST, en commençant à commencez ici

Notez qu'il existe deux scripts Python pratiques qui peuvent générer un point de départ pour un nouvel article.

Générer un point de départ d'article sans image

newarticle -h

usage: newarticle [-h] [-a AUTHOR] [-l {en,fr,es,all}] [-d DUP] [-r]
                  articlename

Generate a skeleton article file

positional arguments:
  articlename           article name without the "-en.rst")

options:
  -h, --help            show this help message and exit
  -a AUTHOR, --author AUTHOR
                        Author for copyright and for authors (default "Pierre
                        Bernatchez)"
  -l {en,fr,es,all}, --lang {en,fr,es,all}
                        language of the new article (default: all)
  -d DUP, --dup DUP     Existing article name to duplicate category and tags
                        (default None)
  -r, --recipe          Treat this as a recipe. (Othewise generic)

Générer un point de départ d'article avec une image

newshot -h

Sortie

usage: newshot [-h] [-a AUTHOR] [-l {en,fr,es,all}] [-d DUP] [-j] [-r]
               articlename

Generate a skeleton article file which has a srcreenshot

positional arguments:
  articlename           article name without the "-en.rst")

options:
  -h, --help            show this help message and exit
  -a AUTHOR, --author AUTHOR
                        Author for copyright and for authors (default "Pierre
                        Bernatchez)"
  -l {en,fr,es,all}, --lang {en,fr,es,all}
                        language of the new article (default: all)
  -d DUP, --dup DUP     Existing article name to duplicate category and tags
                        (default None)
  -j, --jpg             Reference image as a .jpg rather than a .png a
                        (default: False)
  -r, --recipe          Treat this as a recipe. (Othewise generic)

Thème «Lightweight» pour pelican

2024-12-06T20:02:44+00:00

Description

:Créé le: 14 février 2011
:Technologies utilisées: xHTML5, CSS 1-3, polices TTF
:Couleurs utilisées: Tons froids (gris/bleu)
:Design extensif: Oui
:Testé sous: Mozilla Firefox 4.0b10, Chromium 9.0.597.83, ELinks 0.12pre5
:Langue: Français
:Détails: Voire capture d'écran et source

Ce thème est dérivé du thème lightweight. On a changé la page d´acceuil pour lister un seul article de bienvenu au lieue d´une liste complète d´articles.

Capture d'écran

Configuration du générateur de site Web Pelican

2024-12-02T17:30:00-05:00

Pelican est un générateur de sites web statiques. C'est l'outil que nous utilisons pour maintenir nos sites statiques.

Ce document suppose que nous utilisons venvwrapper [1].

Installation de Pelican

Effectuez cette opération dans notre environnement virtuel Python. Nous avons nommé notre environnement statsites.

Activez-le et installez Pelican.

venv statsites
pip install pelican

Thèmes

Dans chacune de nos configurations pelicanconf.py, nous sélectionnons un thème pour le site concerné. Pour obtenir une sélection de thèmes, nous avons cloné comme suit:

git clone --recursive https://github.com/getpelican/pelican-themes ${HOME}/pelican-themes

Note sur le thème du site

Sur nos propres sites, nous avons apporté quelques ajustements au thème lightweight pour l'adapter à nos besoins.

Nous maintenons ce thème dérivé de lightweight et notre contenu web dans notre dépôt de contrôle de version Git. Notre fichier de configuration pelicanconf-en.py contient cette référence ci dessous.

THEME = u"/home/ubuntu/allrepos/mystatic_sites/derived-themes/lightweight-single-home-en"

Le thème de votre site sera à vous de choisir et/ou de modifier.

Initialiser le système de fichiers du site squelettique

Utilisez pelican-quickstart pour générer le contenu statique initial du site web avec Pelican.

pelican-quickstart crée un système de fichiers de génération de site squelette sous le répertoire vide actuel.

Créez ensuite des fichiers .rst dans les répertoires content/n_importe_quel_nom comme articles de blog. Créez des fichiers .rst dans content/pages comme pages de blog.

Compilation

Générez les fichiers du site web une fois tous nos fichiers sources .rst disponibles. Pour cela, il suffit d'utiliser le Makefile. La procédure suivante compilera et diffusera tout le contenu du site web sous output/ en utilisant Pelican.

make html

Vous pouvez voir vos résultats en appelant le fichier output/index.html.

[1]	Nous utilisons le paquet python venvwrapper pour simplifier la gestion des environnements virtuels. Ceci est supposé dans ce document. Si vous ne l'utilisez pas, vous devez remplacer les lignes telles que "venv statsites" par des lignes telles que "source ${HOME}/.venv/statsites/bin/activate".

Organisation des sources du projet

2024-12-02T17:30:00-05:00

At this writing we are maintaining pelican generated static websites, one for www.bernatchez.net and one for www.ogopogo.biz.

We use our script "compile_rst" to add a few generated .rst files to the source site before using pelican to generate the site from source.

We can generate a list of links to the files in a subdirectory.

Accomplished like this in the Makefile.

$(COMPILE_RST) -p '*.pdf' -s sitepdfs -o pdfs_list -i

That would generate a link for each .pdf file in sitepdfs/ and emit the result to the file pdfs_list.rst

Such a file is intended to be included within one or more of our manually produced .rst pages with a line like:

.. include:: ../../pdfs_list.rst

That would include our generated link list in that page.

We can also generate music album like pages with links to the files in a compilation subdirectory.

Accomplished like this in the Makefile.

$(COMPILE_RST) -p '*.mp3' -s compilations -o album -a

This would generate - possibly - several album_N.rst files in the pages/ subdirectory, where N is a sequence number. You will get as many pages as there are albums referenced in the m3 files in the compilations directory.

Invocations of compile_rst must take place every time the make html target is requested.

For example, the bernatchez_staticweb Makefile contains this

html:

    $(COMPILE_RST) -p '*.mp3' -s compilations -o album -a
    $(COMPILE_RST) -p '*.tar.gz' -s tarballs -o tarballs_list -i
    $(COMPILE_RST) -p '*.pdf' -s sitepdfs -o pdfs_list -i
    $(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(CONFFILE) $(PELICANOPTS)

So that content/pages/album_N.rst files and tarballs_list.rst, pdfs_list.rst are all regenerated prior to invoking pelican to generate the site.

In short

Files tarballs/*.tar.gz , sitepfds/*.pdf, and compilations/*.mp3 as well as all the .rst files under the content subdirectory determine what goes into our website.

At this writing the content is only proof of concept data.

Captures d'écran de thèmes Pelican

2024-12-02T17:30:00-05:00

Ordre décroissant de préférence

lightweight

THEME = "/home/ubuntu/pelican-themes/lightweight"

sneakyidea

THEME = "/home/ubuntu/pelican-themes/sneakyidea"

basic

THEME = "/home/ubuntu/pelican-themes/basic"

notmyidea-cms

THEME = "/home/ubuntu/pelican-themes/notmyidea-cms"

notebook

THEME = "/home/ubuntu/pelican-themes/notebook"

cebong

THEME = "/home/ubuntu/pelican-themes/cebong"

relapse

THEME = "/home/ubuntu/pelican-themes/relapse"

bold

THEME = "/home/ubuntu/pelican-themes/bold"

bootstrap2-dark

THEME = "/home/ubuntu/pelican-themes/bootstrap2-dark"

franticworld

THEME = "/home/ubuntu/pelican-themes/franticworld"

Entretien des thèmes

2024-12-02T17:30:00-05:00

Notes regarding selecting and tweaking pelican themes used with our sites.

To be able to use/tweak pelican themes for my pelican projects I cloned the full collection of pelican themes to my local machine.

git clone --recursive https://github.com/getpelican/pelican-themes /home/ubuntu/pelican-themes

I then replicated the tree to use as a basis for getting a diff to identify any changes that I made during the course of tweaking themes I use.

cp -r ${HOME}/pelican-themes ${HOME}/pelican-themes.orig
chmod -w --recursive ${HOME}/pelican-themes.orig  # To make my orig write protected for reliable diffs later.

Do this once in a while as we tweak themes we are using, so we can keep a record of our tweaks.

cd ${HOME}/pelican-themes
diff -Naru ../pelican-themes.orig . > ../pelican-themes.patch

Note:

-N --new-file treat absent files as empty

-a --text treat all files as text

-r --recursive recursively compare subdirectories

-u -U --unified[=NUM] Output NUM lines of unified context (default 3)

Thèmes Pelican

2024-11-18T20:41:00-05:00

sneakyidea

THEME = "/home/ubuntu/pelican-themes/sneakyidea"

lightweight

THEME = "/home/ubuntu/pelican-themes/lightweight"

basic

THEME = "/home/ubuntu/pelican-themes/basic"

notmyidea-cms

THEME = "/home/ubuntu/pelican-themes/notmyidea-cms"

bold

THEME = "/home/ubuntu/pelican-themes/bold"

Note de clonage Github

2015-03-19T11:47:31-04:00

Si vous venez de cloner le dépôt « mypelican_static_sites », vous devez effectuer quelques étapes avant de générer les sites.

Prérequis

Nos compilations pour les sites gérés ici reposent sur le projet « flitprojects », qui est également sous contrôle de version dans notre compte Github. Ce projet utilise des environnements virtuels Python. Nous supposons donc qu'un environnement virtuel adéquat est configuré, et que nous avons exécuté flit build et flit install dans celui-ci pour le paquet « flitprojects/articleware ».

Étapes de configuration après un nouveau clonage de « mypelican_static_sites »

Installer les scripts pour générer les versions PDF de tous les articles. Ces scripts sont générés et ne sont donc pas conservés sous contrôle de version. Nous utilisons un script bash pour identifier la liste des sous-répertoires de sites et générer nos scripts dans chacun d'eux.

allputs.sh
# ceci génère une paire de scripts dans chaque sous-répertoire
# qui contient des fichiers .rst d'articles.

Une fois les scripts générés, nous devons produire tous les fichiers .pdf. Pour ce faire, on accède à l'un des sous-répertoires de site et on utilise make pour générer les fichiers .pdf.

cd www.bernatchez.net
make pdfs

Générez vos versions locales des sites afin de vérifier qu'elles sont prêtes à être publiées.

cd www.bernatchez.net
make html
cd ..

cd blog.bernatchez.net
make html
cd ..

cd www.ogopogo.biz
make html
cd ..

cd docs.pelican.bernatchez.net
make html
cd ..

Générez les versions publiables de vos sites et publiez-les.

cd www.bernatchez.net
make pubhtml
cd ..

cd blog.bernatchez.net
make pubhtml
cd ..

cd www.ogopogo.biz
make pubhtml
cd ..

# Utiliser uniquement la version système de fichiers pour celui-ci, ne pas générer.
# Nous ne maintenons pas le site avec le CDS bunny.
cd docs.pelican.bernatchez.net site
echo 'Nous ne maintenons pas le site "docs.pelican.bernatchez.net" avec le CDS bunny.'
cd ..

L'utilisation de make avec « pubhtml » génère des URL en ligne dans de nombreux liens du contenu. Cela est incompatible avec le contenu généré par make « html », dont les liens doivent tous être relatifs au système de fichiers. Cela signifie que le contenu sur le système de fichiers local n'est plus valide immédiatement après la génération du contenu « pubhtml ». Nous devons donc relancer make « html » une fois le contenu publié afin de rétablir le contenu local dans son état correct.

cd www.bernatchez.net
make html
cd ..

cd blog.bernatchez.net
make html
cd ..

cd www.ogopogo.biz
make html
cd ..

Dépannage de la Génération de Site

2015-03-19T11:47:31-04:00

I intend to keep adding to this note as further issues crop up and workarounds are discoverd.

1- I found that when we use the same slug for different language versions of the same article.

pelican does a nice job of picking out the current default language's version for the site. When no version exists which matches the current default language, then pelican emits warnings and/or errors regarding the other language versions.

The work around is to always make sure you have all the language versions you are supporting, or just a single one. When that is the case it seems to behave adequately.

It seems sensible to translate attribute values too, other than slug of course.

Articles du site en format PDF

2015-03-11T12:47:00-04:00

En format PDF