[BugFix] Doxygen builds failing on rtd, and locally#1442
Merged
andrew-platt merged 2 commits intoOpenFAST:rc-3.4.1from Feb 10, 2023
Merged
[BugFix] Doxygen builds failing on rtd, and locally#1442andrew-platt merged 2 commits intoOpenFAST:rc-3.4.1from
andrew-platt merged 2 commits intoOpenFAST:rc-3.4.1from
Conversation
I have a suspicion that the argument parsing in python or some package in it changed (I can reproduce the issue locally).
There is an arguement in `CMakeListst.txt` for the `sphinx-html` command that indicates where the `conf.py` is located (`-c ${CMAKE_CURRENT_BINARY_DIR}`). This is at the end of the command for `sphinx-html`.
The argument parsing in `conf.py` is assuming this last argument doesn't count as it finds the arguments for the path to `doxygen` and `openfast.tag`. Something somewhere appears to have changed this behavior.
Removing this last argument restores the ability for me to build locally and for rtd to build and really has no impact as conf.py gets copied to the build dir.
Still have no clue what changed at rtd to cause this -- maybe a newer python?
Collaborator
Author
|
|
Collaborator
Author
|
RTD build for this PR: https://readthedocs.org/projects/ap-openfast/builds/19428487/ |
Collaborator
|
I agree with this as a stop gap, but I'm not sure if this should close #1423. Since this suppresses the issue rather than fix it, it might be worthwhile to keep that open and add the details included in the PR description here, for future reference. |
rafmudaf
approved these changes
Feb 9, 2023
deslaughter
approved these changes
Feb 10, 2023
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.
This is ready to merge
Feature or improvement description
Something in RTD changed in January 2023 causing our documentation to fail if
doxygenis enabled. This is due to an issue with the paths to doxygen. The change occurred sometime after the 3.4.0 release.Exactly what changed is a bit unknown: looking through the logs for both yielded very little useful information. A handful of python packages had minor updates, but nothing major that we would expect to change the results. Also whatever changed also affects local builds (only for updated python packages).
For this fix,
doxygenhas been turned off on RTD (we don't think anyone uses it). Doxygen is still built locally and should work on most systems still.Related issue, if one exists
#1423 has some additional details
Impacted areas of the software
Only the documentation is affected.
Additional information
We would like to include this in a bugfix release, 3.4.1
Test results, if applicable
none