Skip to content

Auto-generate API documentation with each commit to master using Github Actions #205

Closed
@diptorupd

Description

@diptorupd

Currently, I have been updating the API docs for dpctl by manually generating and pushing the documents to the gh-pages branch. The steps that I use are:

Step 1

git checkout master
cd docs
mkdir build
cd build 
cmake -DDPCTL_DOCGEN_PREFIX=<Some location out of tree>
make Sphinx

Step 2

git clean -dfx
git checkout gh-pages
git rm -rf *
mv <Location where docs were generated in first step> .
git ci -m "Updated docs."
git push

We should be able to do these using Azure as part of CI.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions