Skip to content

Commit 6da4fde

Browse files
committed
Move doxygen generation to release workflow
1 parent aa46729 commit 6da4fde

File tree

3 files changed

+13
-32
lines changed

3 files changed

+13
-32
lines changed

.github/workflows/docs.yml

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

.github/workflows/release.yml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,23 @@ jobs:
2626
steps:
2727
- name: Checkout
2828
uses: actions/checkout@v3
29+
- name: Install doxygen & zip
30+
run: sudo apt-get update && sudo apt-get install doxygen graphviz zip -y
31+
- name: Generate Doxygen Documentation
32+
run: doxygen Doxyfile
33+
- name: Create .nojekyll
34+
run: touch docs/html/.nojekyll
35+
- name: Deploy Documentation to branch
36+
uses: JamesIves/github-pages-deploy-action@v4
37+
with:
38+
branch: docs
39+
folder: docs/html
2940
- name: Copy LICENSE
3041
run: cp LICENSE include/bitstream/LICENSE
3142
- name: Copy NETSTACKLICENSE
3243
run: cp NETSTACKLICENSE include/bitstream/NETSTACKLICENSE
3344
- name: Create VERSION.txt
3445
run: echo "${{ inputs.tagName }}" > include/bitstream/VERSION.txt
35-
- name: Install zip
36-
run: |
37-
sudo apt update
38-
sudo apt install -y zip
3946
- name: Zip headers
4047
run: zip -r BitStream.zip include/bitstream
4148
- name: Tar headers

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ It is also possible to dynamically put a break point or trap when a bitstream wo
4040
For more examples of usage, see the [Serialization Examples](#serialization-examples) below.
4141
You can also look at the unit tests to get a better idea about what you can expect from the library.
4242

43-
# Interface
44-
Refer to [INTERFACE.md](INTERFACE.md) for more detailed information about what can be accessed in the library.
43+
# Documentation
44+
Refer to [the documentation](https://kredegc.github.io/BitStream/namespaces.html) for more information about what different classes provide.
4545

4646
# Serializables - serialize_traits
4747
Below is a noncomprehensive list of serializable traits.

0 commit comments

Comments
 (0)