Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GHA: build docs from BOOST_ROOT #1329

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

sdarwin
Copy link

@sdarwin sdarwin commented Oct 11, 2024

Hi,
I have some scripts that build each boost library's documentation individually, to test they are working as expected. (Those scripts are in release-tools/build_docs).

For all other boost libraries, this technique works:

cd $BOOST_ROOT
./b2 _path_to_library_docs_

boostorg/geometry is an exception. This pull request demonstrates that. Would you be able to decipher why it happens and adjust the process?

Notice that even the "Build examples" job follows this pattern.

cd $BOOST_ROOT
./b2 _path_to_examples_

With earlier versions of geometry, I was implementing a hack, that probably wasn't ideal.

  • Manually run ./b2 $librarypath/doc/src/docutils/tools/doxygen_xml2qbk
  • That built dist/bin/doxygen_xml2qbk which I added to PATH, so it could be discovered.

It solved the problem temporarily. Now the hack is not working either, but a more official solution is preferable, anyway.

@barendgehrels
Copy link
Collaborator

Thanks @sdarwin
I didn't look in detail yet, but the CI fails on this PR. This means it's not backwards compatible. How can that be fixed?

@sdarwin
Copy link
Author

sdarwin commented Oct 30, 2024

@barendgehrels this is both an issue and a pull request.

The geometry docs are not building in the same way that other boost libraries do. The CI failure here demonstrates that.

./b2 _path_to_library_docs_

should work, but it doesn't.

@barendgehrels
Copy link
Collaborator

@barendgehrels this is both an issue and a pull request.

OK I see. So it proves the CI doesn't work. But it gets a bit a difficult state now. Because it's not an issue (because a PR) and the PR itself is not good.

@vissarion any idea how we can solve this?

Copy link
Collaborator

@barendgehrels barendgehrels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prevent merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants