Add Doxygen documentation and a GitHub Pages workflow - #3
Merged
Conversation
Doxygen comments (with usage examples) cover the public API only -- Expressionist::Expressionist, EvalMethod, ExpressionistException, and the expressionist_c.h C ABI -- while the internal tokenizer/parser/evaluator in the detail namespace stays undocumented and is excluded from the generated site. The Doxyfile renders README.md as the site's main page and links the example program in via \example. Docs are generated into doc/ (gitignored, not versioned) with `doxygen Doxyfile`. A new GitHub Actions workflow rebuilds and publishes them to GitHub Pages on every push to main. Also fixes a .gitignore line where ".claude" and "__pycache__/" had been concatenated onto one line by a prior edit. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PSusXDdkjoi4ofSB9zJMoE
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doxygen comments (with usage examples) cover the public API only --
Expressionist::Expressionist, EvalMethod, ExpressionistException, and the
expressionist_c.h C ABI -- while the internal tokenizer/parser/evaluator in
the detail namespace stays undocumented and is excluded from the generated
site. The Doxyfile renders README.md as the site's main page and links the
example program in via \example.
Docs are generated into doc/ (gitignored, not versioned) with
doxygen Doxyfile. A new GitHub Actions workflow rebuilds and publishes them toGitHub Pages on every push to main.
Also fixes a .gitignore line where ".claude" and "pycache/" had been
concatenated onto one line by a prior edit.
Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01PSusXDdkjoi4ofSB9zJMoE