Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

feat: Generate and publish an automated documentation of the app #898

Merged
merged 12 commits into from
Mar 3, 2022
28 changes: 28 additions & 0 deletions .github/workflows/generate-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# .github/workflows/documentation.yml
name: Documentation

on:
push:
branches:
- '*'

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- name: Generate Documentation
uses: SwiftDocOrg/swift-doc@master
with:
inputs: Sources/
module-name: OpenFoodFacts
output: Documentation/
- name: Update Permissions
run: 'sudo chown --recursive $USER Documentation'
- name: Deploy API documentation to Github Pages
uses: JamesIves/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: Documentation/
4 changes: 4 additions & 0 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
author_url: https://github.com/openfoodfacts/openfoodfacts-ios
author: Pierre Slamich
github_url: https://github.com/openfoodfacts/openfoodfacts-ios
theme: fullwidth
1 change: 1 addition & 0 deletions Documentation/index.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@