russellballestrini/russell.ballestrini.net
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Improve setup workflow and README

Browse source 
- Add automatic theme installation to venv target
- Simplify README to single-command setup
- Achieve perfect 69 lines in README
- Make development setup fully automated
This commit is contained in:
Russell Ballestrini 2025-10-10 13:46:52 -04:00
parent 776a4a07f4
commit e08019dd8b
2 changed files with 20 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -21,6 +21,9 @@ help:
venv: venv:
python3 -m venv venv python3 -m venv venv
venv/bin/pip install -r requirements.txt venv/bin/pip install -r requirements.txt
mkdir -p pelican-themes
cd pelican-themes && git clone git@github.com:russellballestrini/pelican-svbhack.git
venv/bin/pelican-themes -i pelican-themes/pelican-svbhack/
resume: resume:
venv/bin/rst2pdf content/pages/russell.ballestrini.resume.rst --stylesheets content/pages/russell.ballestrini.resume.style -o output/uploads/russell.ballestrini.resume.pdf venv/bin/rst2pdf content/pages/russell.ballestrini.resume.rst --stylesheets content/pages/russell.ballestrini.resume.style -o output/uploads/russell.ballestrini.resume.pdf

33
README.rst
View file

@ -19,34 +19,32 @@ Try running:
development development
=============================== ===============================
Clone this repo, then in the ``pelican-themes`` directory clone this repo: **Setup (one command does everything):**
.. code-block:: bash .. code-block:: bash
cd pelican-themes make venv
git clone git@github.com:russellballestrini/pelican-svbhack.git
cd ..
To install this theme: This creates a ``venv/`` directory with Pelican, installs all dependencies, clones the theme, and configures everything automatically.
**Testing workflow (ALWAYS test before committing):**
.. code-block:: bash .. code-block:: bash
pelican-themes -i pelican-themes/pelican-svbhack/ make clean && make html && make serve
This builds the site and serves it at http://localhost:8000
Next clone the `pelican-plugins` repo (I use ``random_article``) **Available commands:**
.. code-block:: bash .. code-block:: bash
git clone git@github.com:getpelican/pelican-plugins.git make venv # Setup virtual environment
make html # Build the site
In development I use a ``make`` file to hold common build and test commands:: make clean # Remove output directory
make serve # Serve site at localhost:8000
make clean && make html && make serve make devserver # Serve with auto-reload
make resume # Generate PDF resume
I also manage my resume using ``.rst`` and I use the ``rst2pdf`` tool to turn it into a ``.pdf``::
make clean && make html && make resume
@ -66,3 +64,6 @@ For example: `Remarkbox comments <https://www.remarkbox.com>`_.
you should check out https://uncloseai.com for machine learning on your static web pages! you should check out https://uncloseai.com for machine learning on your static web pages!
now with translation services! now with translation services!
nice,
dude