Gopesh Bhardwaj
076f4d8427
* readthedocs updates
* Adding License
* correcting table of contents path
* Move doc requirements to sphinx dir
* Compile requirements.txt
* Update path to reqs
* Adding missing python module
* changing sphinx version
* changing docutils version
* enabling sphinx extensions
* trying sphinx-rtd-theme
* Remove unused doc configs
* Remove unused html theme options
* Add files to toc
* temp commit to test
* updating environment.yml for CI build
* Update doc requirements
To include rocprofiler-sdk in projects.yaml
* Set external_projects_current_project as rocprofiler-sdk
* Exclude external projects
* Fix warning for missing static path
* updating conf.py
* Removing reST syntax
* Use rocm-docs-core doxygen integration
* Remove RST syntax from Markdown files
* Generate doxyfile post checkout on RTD
* Use custom RTD env
* Specify mambaforge
* Put conda before post checkout cmd
* Add doxyfile for RTD
* Run cmake from conf.py
* Update environment.yml
* Use mambaforge
* Fix path to environment.yml
* Call build doxyfile
* Add Developer API title to Doxyfile
* Config version header
* Fix typo in conf.py
* Format fix for conf.py
* Increasing timeout for build-docs-from-source
* Remove README as mainpage for doxyfile
* Fix formatting in conf.py
---------
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
[ROCm/rocprofiler-sdk commit: a60c4def00]
120 строки
3.3 KiB
YAML
120 строки
3.3 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches: [ amd-staging, amd-mainline ]
|
|
paths:
|
|
- '*.md'
|
|
- 'VERSION'
|
|
- 'source/docs/**'
|
|
- 'source/scripts/update-docs.sh'
|
|
- 'source/include/rocprofiler-sdk/**'
|
|
- '.github/workflows/docs.yml'
|
|
pull_request:
|
|
paths:
|
|
- '*.md'
|
|
- 'VERSION'
|
|
- 'source/docs/**'
|
|
- 'source/scripts/update-docs.sh'
|
|
- 'source/include/rocprofiler-sdk/**'
|
|
- '.github/workflows/docs.yml'
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
|
|
|
|
jobs:
|
|
build-docs:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: true
|
|
- name: Install Conda
|
|
uses: conda-incubator/setup-miniconda@v3
|
|
with:
|
|
miniconda-version: "latest"
|
|
auto-activate-base: true
|
|
activate-environment: ""
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v5
|
|
- name: Create Docs Directory
|
|
run:
|
|
mkdir -p docs
|
|
- name: Install Conda environment
|
|
shell: bash -el {0}
|
|
working-directory: source/docs
|
|
run: |
|
|
conda env create -n rocprofiler-docs -f environment.yml
|
|
- name: Build Docs
|
|
shell: bash -el {0}
|
|
working-directory: source/docs
|
|
run: |
|
|
source activate
|
|
conda activate rocprofiler-docs
|
|
../scripts/update-docs.sh
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: ./docs
|
|
|
|
deploy-docs:
|
|
if: github.ref == 'refs/heads/amd-mainline'
|
|
runs-on: ubuntu-latest
|
|
needs: build-docs
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|
|
|
|
build-docs-from-source:
|
|
runs-on: gpuless-runner-set
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: true
|
|
|
|
- name: Install requirements
|
|
timeout-minutes: 10
|
|
shell: bash
|
|
run: |
|
|
git config --global --add safe.directory '*'
|
|
apt-get update
|
|
apt-get install -y cmake gcc g++ libdw-dev
|
|
python3 -m pip install -r requirements.txt
|
|
|
|
- name: Configure, Build, Install, and Package
|
|
timeout-minutes: 60
|
|
shell: bash
|
|
run:
|
|
export CMAKE_PREFIX_PATH=/opt/rocm:${CMAKE_PREFIX_PATH};
|
|
cmake -B build
|
|
-DROCPROFILER_DEP_ROCMCORE=ON
|
|
-DROCPROFILER_BUILD_DOCS=ON
|
|
-DCMAKE_INSTALL_PREFIX=/opt/rocprofiler-sdk
|
|
-DCPACK_GENERATOR='DEB;RPM;TGZ'
|
|
-DCPACK_PACKAGING_INSTALL_PREFIX="$(realpath /opt/rocm)"
|
|
-DPython3_EXECUTABLE=$(which python3)
|
|
. &&
|
|
cmake --build build --target docs --parallel 4 &&
|
|
cmake --build build --target all --parallel 12 &&
|
|
cmake --build build --target install --parallel 12 &&
|
|
cmake --build build --target package --parallel 12
|