Skip to content

Commit 06f2c52

Browse files
committed
ci: add doc build to CI
1 parent 63ec292 commit 06f2c52

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

.github/workflows/ci.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,42 @@ jobs:
7676
with:
7777
fail_ci_if_error: false
7878
token: ${{ secrets.CODECOV_TOKEN }}
79+
html-docs:
80+
name: Build HTML documentation
81+
runs-on: ubuntu-24.04
82+
steps:
83+
- uses: actions/checkout@v4
84+
- name: Setup PDM
85+
uses: pdm-project/setup-pdm@v4
86+
with:
87+
python-version: "3.11"
88+
cache: true
89+
- name: Install dependencies
90+
run: pdm sync -d -G docs
91+
- name: Build HTML
92+
run: pdm run sphinx-build -b html docs docs/_build/html
93+
- uses: actions/upload-artifact@v4
94+
with:
95+
name: html-docs
96+
path: docs/_build/html
97+
manpage-docs:
98+
name: Build manpage
99+
runs-on: ubuntu-24.04
100+
steps:
101+
- uses: actions/checkout@v4
102+
- name: Setup PDM
103+
uses: pdm-project/setup-pdm@v4
104+
with:
105+
python-version: "3.11"
106+
cache: true
107+
- name: Install dependencies
108+
run: pdm sync -d -G docs
109+
- name: Build manpage
110+
run: pdm run sphinx-build -b man docs docs/_build/man
111+
- uses: actions/upload-artifact@v4
112+
with:
113+
name: manpage
114+
path: docs/_build/man/getmac.1
79115

80116

81117
# TODO: publish releases using CI

docs/misc_docs/TODO.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
- Document these features in the README/docs, including the CLI arguments
4747

4848
## Enhancements/fixes/misc.
49+
- [ ] Python 3.13 + 3.14
4950
- [ ] Properly support WSL2
5051
- [ ] address all TODOs in the code
5152
- [ ] implement proper default interface detection on Windows

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,14 @@ classifiers = [
4949
"Topic :: Utilities",
5050
"Typing :: Typed",
5151
]
52-
keywords=[
52+
keywords = [
5353
"getmac",
5454
"get-mac",
5555
"macaddress",
5656
"mac-address",
5757
"mac",
5858
"ethernet",
5959
"mac-48",
60-
"networking",
6160
"network",
6261
"networking",
6362
"layer2",

0 commit comments

Comments
 (0)