Skip to content

Commit b0c2a33

Browse files
committed
Build documentation from sources
1 parent 3f7cdd7 commit b0c2a33

File tree

678 files changed

+39
-50012
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

678 files changed

+39
-50012
lines changed

.github/workflows/main.yml

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ on:
55
branches:
66
- main
77

8+
env:
9+
LATEST_VERSION: 3.0.18
10+
811
jobs:
912
build:
1013
name: Publish site
@@ -13,14 +16,40 @@ jobs:
1316
steps:
1417
- name: Checkout
1518
uses: actions/checkout@v4
16-
- name: Build and Deploy
19+
- name: Replace version name
20+
env:
21+
GH_TOKEN: ${{ github.token }}
22+
run: |
23+
sed -i "s#v0\.19\.2#${{ env.LATEST_VERSION }}#g" content/_index.md
24+
export GITHUB_PAGES_URL=$(gh api "repos/${{ github.repository }}/pages" --jq '.html_url')
25+
sed -i "s#https:\/\/libical\.github\.io#${GITHUB_PAGES_URL}#g" config.toml
26+
export GITHUB_CODE_WEBSITE="${{ github.server_url }}/${{ github.repository }}"
27+
sed -i "s#https:\/\/github.com\/libical\/io.github.libical#${GITHUB_CODE_WEBSITE}#g" config.toml
28+
- name: Build website
1729
uses: shalzz/[email protected]
1830
env:
1931
BUILD_ONLY: true
32+
- name: Checkout libical v${{ env.LATEST_VERSION }}
33+
uses: actions/checkout@v4
34+
with:
35+
repository: libical/libical
36+
ref: v${{ env.LATEST_VERSION }}
37+
path: libical-sources
38+
- name: Install dependencies
39+
run: sudo apt-get -y install gtk-doc-tools xml-core libdb-dev gobject-introspection libgirepository1.0-dev cmake ninja-build doxygen graphviz
40+
- name: Configure libical
41+
run: |
42+
cd libical-sources
43+
mkdir build
44+
cmake -B build -G Ninja -DENABLE_GTK_DOC=True -DICAL_GLIB=True -DGOBJECT_INTROSPECTION=True -DICAL_BUILD_DOCS=True
45+
- name: Build libical documentation
46+
run: |
47+
cd libical-sources
48+
cmake --build build --target docs
2049
- name: Move Documentation
2150
run: |
2251
sudo rm -R public/docs/developer/libical
23-
sudo mv public/apidocs public/docs/developer/libical
52+
sudo mv libical-sources/build/apidocs/html public/docs/developer/libical
2453
sudo rm -R public/docs/developer/libical-glib
2554
sudo mv public/libical-glib public/docs/developer/libical-glib
2655
- name: Upload Artifact

content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ url = "/docs/getting-started/introduction/"
99
url_button = "Get started"
1010
repo_version = "v3.0.18"
1111
repo_license = "MPL v2.0 or LGPL v2.1 —"
12-
repo_url = "https://github.com/aaranxu/adidoks"
12+
repo_url = "https://github.com/libical/libical/"
1313

1414
# Menu items
1515
[[extra.menu.main]]

content/docs/maintainers/update-api-documentation.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,17 @@ sort_by = "weight"
99
template = "docs/page.html"
1010

1111
[extra]
12-
lead = "Update the public API documentation."
12+
lead = "Update the Website and public API documentation."
1313
toc = true
1414
top = false
1515
+++
1616

17-
Make sure you have Doxygen installed; else this will fail.
17+
Clone the website:
1818

19-
Like so:
20-
21-
```bash
22-
git checkout 3.0 #your stable branch
23-
mkdir build-apidox; cd build-apidox
24-
cmake -G Ninja .. && ninja docs
25-
git checkout gh-pages
26-
cd ..; rm -rf apidocs; cp -dpr build-apidox/apidocs/html apidocs
27-
git add apidocs #make sure to include any newly generated files
28-
git commit -m "update apidox" --no-verify . && git push
19+
```
20+
git clone https://github.com/libical/io.github.libical.git
2921
```
3022

31-
view it on [https://libical.github.io/docs/developer/libical/](@/docs/developer/libical.md) (might take a couple minutes to update)
32-
33-
add the generated `build-apidox/libical.tag` file to the github release
23+
Open the file in `.github/workflows/main.yml` and update `LATEST_VERSION` to the
24+
new version. Commit and push to the repository to trigger a website and
25+
documentation update.

static/apidocs/annotated.html

Lines changed: 0 additions & 187 deletions
This file was deleted.

static/apidocs/astime_8h.html

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)