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.

Sign up for GitHub

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

Fix doc build only #36

Merged
merged 3 commits into from
Jan 9, 2025
Merged

Fix doc build only #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0220f6
doc: Fix inconsistent levels
krish2718 Jan 9, 2025
d27521d
doc: Do a clean build every time
krish2718 Jan 9, 2025
b2540c3
ci: Fix doc-build
krish2718 Jan 9, 2025
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
12 changes: 8 additions & 4 deletions .github/workflows/docbuild.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ on:
tags:
- v*

env:
DOXYGEN_VERSION: 1.12.0

jobs:
build:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
Expand All @@ -37,7 +40,6 @@ jobs:
sudo apt update
sudo apt-get install -y ninja-build mscgen plantuml
sudo snap install yq
DOXYGEN_VERSION=$(yq ".doxygen.version" ./nrf/scripts/tools-versions-linux.yml)
wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
Expand All @@ -46,7 +48,9 @@ jobs:
working-directory: nrf70_bm_ws
run: |
sudo pip3 install -U setuptools wheel pip
pip3 install -r nrf/doc/requirements.txt
pip3 install -r zephyr/doc/requirements.txt
# docs still use breathe (based on NCS)
pip install breathe

- name: West zephyr-export
working-directory: nrf70_bm_ws
Expand Down Expand Up @@ -109,7 +113,7 @@ jobs:
path: nrf70_bm_ws/nrf70-bm/nrf70_bm_lib/docs/build/html

deploy:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: build
if: github.event_name != 'pull_request'
permissions:
Expand Down
3 changes: 2 additions & 1 deletion build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ generate_doxygen_xml() {
# Function to build Sphinx documentation
build_sphinx_docs() {
echo "Building Sphinx documentation..."
make clean
make html
}

Expand All @@ -25,4 +26,4 @@ main() {
}

# Run the main function
main
main
4 changes: 2 additions & 2 deletions nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ The nRF70 Series BM driver uses the following compiler options and linker flags
The compiler used is ``Zephyr SDK`` which uses ``arm-zephyr-eabi-gcc``. For more information, visit the `Zephyr SDK documentation <https://docs.zephyrproject.org/latest/develop/toolchains/zephyr_sdk.html>`_.

Compiler options
================
----------------

Below is an example of the compiler options used by the nRF70 Series BM driver from `compile_commands.json` in the ``build`` directory:

Expand Down Expand Up @@ -205,7 +205,7 @@ Below is an example of the compiler options used by the nRF70 Series BM driver f
}

Linker flags
============
------------

Below is an example of the linker flags used by the nRF70 Series BM driver from `build.ninja` and `CMakeFiles/rules.ninja` in the ``build`` directory:

Expand Down