Configured Doxygen #26
Merged
Conversation
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
- Updated `Doxyfile` to use local MathJax copy for privacy. - Local copy is downloaded from CDN in `helper.py`. - New option `--doxygen` in helper.py`: - Downloads MathJax files from CDN before build. - Builds documentation using `docs/doxygen/Doxyfile`.
- Added `local`, `remote` and `files` variables for readability. - Switched MathJax source from jsDelivr to GitHub for privacy. - Added `-Z` option to `curl` for parallel download.
- Disabled `INLINE_SOURCES`: - Internal implementation is not very important. - Some functions are too large. - Disabled `HTML_COPY_CLIPBOARD`: - It's not very useful. - Documentation is for reading, not copying.
The `examples` folder should not be added to `INPUT`. The examples will be added to the documentation later, when they are referenced.
pasabanov
added
config
pasabanov
added a commit
that referenced
this pull request
Feb 5, 2025
* Configured version 1.9.8 Doxygen * Updated Doxygen from 1.9.8 to 1.13.2 * Serve MathJax locally instead of CDN for Doxygen - Updated `Doxyfile` to use local MathJax copy for privacy. - Local copy is downloaded from CDN in `helper.py`. - New option `--doxygen` in helper.py`: - Downloads MathJax files from CDN before build. - Builds documentation using `docs/doxygen/Doxyfile`. * Added `doxygen.yml` to build and deploy documentation * Added `graphviz` dependency for Doxygen * Fixed `SITEMAP_URL` as GitHub Pages URLs are case-sensitive * Refactored and changed source of MathJax download - Added `local`, `remote` and `files` variables for readability. - Switched MathJax source from jsDelivr to GitHub for privacy. - Added `-Z` option to `curl` for parallel download. * Configured sources in documentation - Disabled `INLINE_SOURCES`: - Internal implementation is not very important. - Some functions are too large. - Disabled `HTML_COPY_CLIPBOARD`: - It's not very useful. - Documentation is for reading, not copying. * Removed `examples` from `INPUT` in `Doxyfile` The `examples` folder should not be added to `INPUT`. The examples will be added to the documentation later, when they are referenced.
This was referenced Feb 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Types of changes
Related: #19 #22 #25
Description
Added Doxygen version 1.13.2 configuration in
docs/doxygen/Doxyfile:helper.py).Added Doxygen generation support in
helper.pywith--doxygenflag:tex-svg.jsandinput/tex/extensions/physics.jsare downloaded fromhttps://raw.githubusercontent.com/mathjax/MathJax/refs/tags/3.2.2/es5/...to a local folder. This removes the CDN dependency for the documentation site client, improving privacy.graphvizdependency needed for Doxygen was added to thedependencieslist.Added build and deploy documentation on GitHub Pages workflow file:
.github/workflows/doxygen.yml.on: workflow_dispatch:).Future improvements
Implement documentation for all entities in the library.