docs: add auto-generated deviceinfo reference
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7414>
This commit is contained in:
parent
05efd122f2
commit
6d879111b1
5 changed files with 14 additions and 1 deletions
|
|
@ -11,6 +11,7 @@
|
|||
if [ "$(id -u)" = 0 ]; then
|
||||
set -x
|
||||
apk -q add py3-pip make git
|
||||
apk add dint --allow-untrusted --repository=https://mirror.postmarketos.org/postmarketos/master
|
||||
exec su "${TESTUSER:-build}" -c "sh -e $0"
|
||||
fi
|
||||
|
||||
|
|
|
|||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -67,6 +67,7 @@ instance/
|
|||
|
||||
# Documentation
|
||||
public
|
||||
docs/deviceinfo-reference.md
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
|
|
|||
|
|
@ -14,4 +14,3 @@ run:
|
|||
python3 -m http.server -b 127.0.0.1 8081 -d ../public
|
||||
|
||||
.PHONY: default venv run
|
||||
|
||||
|
|
|
|||
11
docs/conf.py
11
docs/conf.py
|
|
@ -1,6 +1,8 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
|
||||
import datetime
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
|
||||
project = "pmaports"
|
||||
copyright = str(datetime.date.today().year) + ", postmarketOS contributors"
|
||||
|
|
@ -23,3 +25,12 @@ html_theme_options = {
|
|||
|
||||
# Set the explicit title of the HTML output
|
||||
html_title = "postmarketOS Packaging"
|
||||
|
||||
|
||||
def run_dint_doc(app):
|
||||
with Path(__file__).parent.joinpath("deviceinfo-reference.md").open("w") as f:
|
||||
subprocess.call(["dint", "doc"], stdout=f)
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.connect("builder-inited", run_dint_doc)
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ in pmaports and the processes around device categorization.
|
|||
|
||||
approval-rules
|
||||
device-categorization
|
||||
deviceinfo-reference
|
||||
ci-tags
|
||||
kernel-versions
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue