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

[ci] Simplify the documentation CI #1314

Merged
merged 1 commit into from
Sep 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
# Copyright (c) 2020 Mateusz Loskot <[email protected]>
# Copyright (c) 2020 Adam Wulkiewicz, Lodz, Poland
#
# This file was modified by Oracle on 2024.
# Modifications copyright (c) 2024 Oracle and/or its affiliates.
# Contributed and/or modified by Vissarion Fysikopoulos, on behalf of Oracle
#
# Use, modification and distribution is subject to the Boost Software License,
# Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
Expand Down Expand Up @@ -84,22 +88,13 @@ jobs:
echo "using xsltproc ;" >> $HOME/user-config.jam
test -f $HOME/user-config.jam && cat $HOME/user-config.jam

- name: Install libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk
run: |
cd $BOOST_ROOT
$BOOST_ROOT/b2 variant=release libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk
test -f /usr/local/bin/doxygen_xml2qbk && rm -rf /usr/local/bin/doxygen_xml2qbk
sudo cp $BOOST_ROOT/dist/bin/doxygen_xml2qbk /usr/local/bin/
ls -l /usr/local/bin/b2
doxygen_xml2qbk --version

- name: Build libs/geometry/doc/src/examples
- name: Build examples
run: |
cd $BOOST_ROOT
$BOOST_ROOT/b2 libs/geometry/doc/src/examples

- name: Run libs/geometry/doc/make_qbk.py
- name: Build documentation
run: |
cd $BOOST_ROOT
cd libs/geometry/doc
python ./make_qbk.py
$BOOST_ROOT/b2
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is perfect! So we call b2 now instead of make_qbk.py, cool.

Can we then remove the fact that make_qbk.py calls b2?
Is everyone following this workflow?
Or do we, if we do that, disturb the making of the official release documentation?

Copy link
Member Author

Choose a reason for hiding this comment

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

I do not know what scripts/workflow is used to build the official release documentation. @barendgehrels do you know?

Loading