Skip to content

Conversation

@nathanmtom
Copy link

Issue #836 highlighted an issue in the calculation of wave power within WEC-Sim for regular waves that were not in deepwater. In order to improve the user understand of wave power calculated within WEC-Sim additional documentation in the regular and irregular theory sections have been added.

@kmruehl kmruehl added Documentation related to docs Wave Class Wave Classs (waveClass.m) Theory related to WEC-Sim theory labels Apr 20, 2022
@kmruehl
Copy link
Collaborator

kmruehl commented Apr 20, 2022

@H0R5E I can't figure out what is causing the docs to trigger the following warning:
/home/runner/work/WEC-Sim/WEC-Sim/docs/theory/theory.rst:376: WARNING: Duplicate explicit target name: "here".

We need to merge this PR, so I'm going to remove the -W --keep-going requirement from sphinx-build -W --keep-going -b html docs docs/_build/html.

@kmruehl kmruehl merged commit 8fb303f into WEC-Sim:dev Apr 20, 2022
@H0R5E
Copy link
Contributor

H0R5E commented Apr 21, 2022

@kmruehl, I see the issue. I think the ideal solution is split this into two, with a stricter check stage and a more permissive build stage. In this way the CI will tell you if something is wrong but won't prevent the docs from building if you choose to merge the docs in a broken state. What do you think?

@kmruehl
Copy link
Collaborator

kmruehl commented Apr 21, 2022

@H0R5E I'm okay with that suggestion. I think failing on a warning is a bit restrictive, but I'm open to this middle ground solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation related to docs Theory related to WEC-Sim theory Wave Class Wave Classs (waveClass.m)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants