Skip to content

Tools enhancements #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 22, 2025
Merged

Tools enhancements #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be09818
helpers: progress logging enhancements
HofiOne Aug 21, 2025
c01409b
serve: do not run tooltip gen twice if not needed
HofiOne Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _plugins/generate_tooltips.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,14 +392,15 @@ def gen_page_link_data(links_dir, link_files_pattern)

def generate_tooltips(page, write_back)
puts "collection: " + (page.respond_to?(:collection) ? page.collection.label : "") + ", ndx: #{page.data["nav_ndx"]}, relative_path: #{page.relative_path}"
puts "------------------------------------"

process_page(page)
#puts "\n\n\n" + page.content

if write_back
write_to_file(page.path, page.content)
end

puts "-----------"
end # def generate_tooltips

end # class << self
Expand Down
9 changes: 6 additions & 3 deletions _tools/navgen
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ add_warning_header ()

gen_navigation()
{
echo "Generating navigation data..."
> "${OUTPUT_FILE}"
add_warning_header "${OUTPUT_FILE}"

Expand All @@ -200,20 +201,22 @@ gen_navigation()

shift
done
echo "YAML navigation structure is generated and saved to $OUTPUT_FILE"
echo -e "YAML navigation structure is generated and saved to $OUTPUT_FILE\n\n\n"
}

gen_links()
{
echo "Generating Jekyll page links..."
rm -Rf _data/links
JEKYLL_BUILD_LINKS='yes' JEKYLL_BUILD_TOOLTIPS='no' bundle exec jekyll build
echo "Jekyll page links are generated and saved to _data/links"
echo -e "Jekyll page links are generated and saved to _data/links\n\n\n"
}

gen_tooltips()
{
echo "Generating Jekyll tooltips..."
JEKYLL_BUILD_LINKS='no' JEKYLL_BUILD_TOOLTIPS='yes' bundle exec jekyll build
echo "Jekyll tooltips are generated and saved"
echo -e "Jekyll tooltips are generated and saved\n\n\n"
}

process_params()
Expand Down
12 changes: 6 additions & 6 deletions _tools/serve
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ stop_dir_watcher() {

# Function to start to serve in the background
start_process() {
echo ""

# FIXME:This would report al the file changes, must parse and filter out waht we are really interested in
#start_dir_watcher

echo -e "\nStarting to serve...\n"

reset_watcher

rm -Rf _site
Expand All @@ -42,13 +42,13 @@ start_process() {
# as the output of it must already be presented to be able to serve a valid content
#
if [ "${JEKYLL_BUILD_LINKS}" == "yes" ]; then
echo -e "Generating navigation data..."
./_tools/navgen ./doc ./_data/navigation.yml
# tooltips will be built at jekyll serve startup automatically if enabled, do not do it twice
JEKYLL_BUILD_TOOLTIPS='no' ./_tools/navgen ./doc ./_data/navigation.yml
fi

echo -e "\nStarting to serve...\n"
JEKYLL_BUILD_LINKS='no' bundle exec jekyll serve ${ALL_PARAMS} &
PROC_PID=$!

echo -e "\n\n\n"
}

stop_process() {
Expand Down