docs.pelican.bernatchez.net

If you have just cloned the "mypelican_static_sites" repostitory, you need to take a few steps before generating the sites.

pre-requisites

Our builds for the sites maintained here rely on the "flitprojects" project that is also under our github account's revision control. That project relies on python virtual environments. So we are assuming that an adequate virtual environment is set up, and that we have done flit build, and flit install into it of the "flitprojects/articleware" package.

Newly cloned "mypelican_static_sites" setup steps

1. Install scripts to generate the pdf versions of all the articles. These scripts are genereated so they are not kept under version control. We use a bash script to identify the list of site subdirectories and generate our scripts within each of those.

allputs.sh
# this generates a pair of scripts in each subdirectory
# that contains article .rst files.

2. Once the scripts have been generated. We need to get all the .pdf files generated. We do that by going to any of the site subdirecgtories and using make to generate the .pdf files.

cd www.bernatchez.net
make pdfs

3. Generate your local versions of your sites so that you can double check that they are good to go.

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 ..

4. Generate the publishable versions of your sites and publish them.

cd www.bernatchez.net
make pubhtml
cd ..

cd blog.bernatchez.net
make pubhtml
cd ..

cd www.ogopogo.biz
make pubhtml
cd ..

# Only use the filesystem version of this one, so don't generate.
# We do not maintain the site with the bunny CDS.
cd docs.pelican.bernatchez.net site
echo 'We do not maintain the site "docs.pelican.bernatchez.net" with the bunny CDS.'
cd ..

5. Make with "pubhtml" yields online locations within many of the links inside the content. This is incompatible with the make "html" generated content whose links must all be file system relative. This means that the content on the local file system is no longer valid immediately after generating "pubhtml" content. So we have to re-run make "html" once we have published the content to revert the local content to what is should be.

cd www.bernatchez.net
make html
cd ..

cd blog.bernatchez.net
make html
cd ..

cd www.ogopogo.biz
make html
cd ..