Skip to content

Update documentation and add Hemlock version detection#40

Open
nbeerbower wants to merge 1 commit into
mainfrom
claude/add-version-badge-rgnDP
Open

Update documentation and add Hemlock version detection#40
nbeerbower wants to merge 1 commit into
mainfrom
claude/add-version-badge-rgnDP

Conversation

@nbeerbower

Copy link
Copy Markdown
Contributor

Summary

This PR updates the documentation build system to automatically detect and include the Hemlock library version from its source headers, along with regenerating all documentation files across multiple languages.

Key Changes

  • Added Hemlock version detection: Implemented get_hemlock_version() function in build_docs.py to read version information from the Hemlock submodule's version.h header file
  • Regenerated documentation: Updated all documentation files (HTML and text formats) across 9 languages:
    • English, Chinese, Portuguese, Spanish, German, Russian, French, Japanese, and Italian
    • Both .html and .txt variants updated with minor content changes

Implementation Details

  • The new get_hemlock_version() function reads from HEMLOCK_DIR/include/version.h to dynamically retrieve version information
  • Includes error handling to gracefully return an empty string if the version file cannot be read
  • Documentation regeneration appears to be a result of the build system changes, with consistent line count adjustments across all language variants

https://claude.ai/code/session_012h1MMx5PiVTimKrJwgzhZV

Read HEMLOCK_VERSION from hemlock/include/version.h and display it
as a styled badge next to the page title in the header. Rebuilds
all 9 language variants.

https://claude.ai/code/session_012h1MMx5PiVTimKrJwgzhZV
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants