Skip to content

Commit

Permalink
The docs now show the version number.
Browse files Browse the repository at this point in the history
The change turned out to be simple, just adding `./docs/_data/version.yml` file with the version number in it. Additionally, added `./docs/_include/nav_footer_custom.html`, which is a simple Liquid tag to read the version file.
This change will necessitate coming up with a solution to keep the code version number in .`/src/tbp/__init__.py` and the new YAML file in sync.
Also updated the `makefile` to use `bundle exec` in front of the documentation commands. That was not clearly spelled out in the Jekyll docs.

Closes #4.
  • Loading branch information
John-Robbins committed Sep 2, 2024
1 parent 39c8008 commit 717a8ae
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"Hillery",
"Imigrantes",
"ITTY",
"jemoji",
"Jonny",
"José",
"Kabhi",
Expand All @@ -67,6 +68,7 @@
"Libertadores",
"Lookin",
"López",
"mathjax",
"maxfail",
"megamouth",
"Mitbestimmungsgesetz",
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ lint:

.PHONY: docs
docs:
cd docs; jekyll build; jekyll serve --livereload; cd ..
cd docs; bundle exec jekyll build; bundle exec jekyll serve --livereload; cd ..

all: mypy lint tests
1 change: 1 addition & 0 deletions docs/_data/version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
number: 0.9.0
5 changes: 5 additions & 0 deletions docs/_includes/nav_footer_custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Puts the tbp version in the navigation footer. -->
<footer class="site-footer">
tbp version : {{site.data.version.number}}
</footer>

0 comments on commit 717a8ae

Please sign in to comment.