Using this Workflow file you can deploy your Doxygen docs to GitHub pages (in this example)
I have created this Workflow for MetaCall/landing-page to deploy their landing page.
They are using Docsify
also for documentation, so that part is also getting deployed using the same workflow file.
My Workflow
Submission Category:
DIY Deployments
Yaml File
name: Doxygen | |
on: | |
repository_dispatch: | |
push: | |
branches: | |
- master | |
- gh-pages | |
# In that case do the job 'make_and_deploy_doxygen' | |
jobs: | |
make_and_deploy_doxygen: | |
runs-on: ubuntu-latest | |
# which needs the following steps to be executed: | |
steps: | |
# 1. Checkout current branch of GitHub repository. | |
- name: Checkout current branch | |
uses: actions/checkout@v2 | |
# 2. Install doxygen and its auxiliary components. | |
- name: Install doxygen and latex components | |
run: sudo apt-get update; sudo apt-get install -y doxygen graphviz texlive-full | |
# 3. Create the doxygen pages. | |
- name: Create the doxygen | |
run: | | |
git clone https://github.com/metacall/core.git | |
mkdir core/build && cd core/build | |
cmake -DOPTION_BUILD_DOCS=ON .. | |
make api-docs | |
- name: Moving Files | |
run: | | |
mv ./core/build/docs/api-docs ./api | |
# Deploy to GitHub Pages | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./ |
Additional Resources / Info
We Are using at MetaCall's Landing Page
metacall
/
landing-page
Repository containing the landing page for MetaCall Core project.
MetaCall allows calling functions, methods or procedures between multiple programming languages.
sum.py
def sum(a, b):
return a + b
main.js
const { sum } = require("./sum.py");
sum(3, 4); // 7
shell
metacall main.js
MetaCall is a extensible, embeddable and interoperable cross-platform polyglot runtime. It supports NodeJS, Vanilla JavaScript, TypeScript, Python, Ruby, C#, Go, C, C++, Rust, D, Cobol and more.
Install
The easiest way to install MetaCall is the following:
curl -sL https://raw.githubusercontent.com/metacall/install/master/install.sh | sh
For more information about other install methodologies and platforms or Docker, check the install documentation.
Examples
You can find a complete list of examples in the documentation. If you are interested in submitting new examples, please contact us in our chats.
Top comments (0)