Docs improvements#452
Draft
rgcoe wants to merge 19 commits into
Draft
Conversation
Coverage Report for CI Build 24580625441Coverage increased (+0.1%) to 88.079%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
Improve the local documentation build workflow, especially on Windows. - make docs example copying idempotent in docs/source/conf.py - add an environment-variable option to skip theory animation generation - add an environment-variable option to skip gifsicle optimization - make docs/clean_docs.py report cleanup failures without aborting These changes help local doc builds succeed when generated files are reused between Sphinx phases or when optional tools like gifsicle are not installed.
Add a script and generated static assets for illustrating the time/frequency equivalence used by the pseudo-spectral method. This includes: - a static figure showing the relationship between Fourier coefficients, harmonics, collocation points, and the periodic time trajectory - a WaveBot animation showing an actual pseudo-spectral solution iterate history - a Python script that reproduces these documentation assets The generated files are committed so documentation builds do not depend on external optimization-history data or additional runtime generation steps.
… tut1 with wot3p2p1
Update the theory documentation to include the new time/frequency equivalence discussion and WaveBot solution animation. This commit also wires the visualization generation into the documentation build configuration.
Collaborator
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
3 participants
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.
Description
Clean up and improvements to documentation pages.
TODO: not sure what this is, but maybe can be removed? https://github.com/rgcoe/WecOptTool/blob/8577c0ed17596ae47799c97c56077422f246f7ef/wecopttool/core.py#L80-L82