From bae1d9a07119510279b0f8f2a2d98f1a5df47c60 Mon Sep 17 00:00:00 2001 From: RibhuDP Date: Mon, 20 May 2024 12:36:00 +0530 Subject: [PATCH] Update doc build process 1. Update pull request template instruction for doc build 2. Update requirements and doc.yml for sphinx installation Signed-off-by: RibhuDP --- .github/pull_request_template.md | 2 +- .github/workflows/doc.yml | 4 ++-- docs/source/requirements.txt | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5182341..147273e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,4 +15,4 @@ If this PR contains a breaking change, list dependent PRs and try to push all re - [ ] I have build all projects affected by the changes in this PR - [ ] I have tested in hardware affected projects, at the relevant boards - [ ] I have signed off all commits from this PR -- [ ] I have updated the documentation by running CI/gen_doc/docs/gen_sysobj_doc.m script locally, if applies. \ No newline at end of file +- [ ] I have updated the documentation by running /docs/source/reference_api/gen_sysobj_doc.m script locally, if applies. \ No newline at end of file diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 409eadf..aa0f6d1 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -11,9 +11,9 @@ jobs: with: submodules: recursive - name: Set up Python 3.7 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: - python-version: 3.7 + python-version: 3.x - name: Install dependencies run: | diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 38e1f0c..eb0a0d6 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,3 +1,3 @@ -sphinx myst_parser +sphinx https://github.com/analogdevicesinc/doctools/releases/download/latest/adi-doctools.tar.gz \ No newline at end of file