Skip to content

Commit

Permalink
devcontainer: Add with adoc serve
Browse files Browse the repository at this point in the history
Add the .devcontainer specification file.
This markup file is used to bring up GitHub Codespaces with the
necessary doc requirements installed and with the live editing daemon
running (adoc serve from adi_doctools).
Codespaces usage is billed to the user.
This is primarily intended for individuals who are unfamiliar with
Linux, seeking a plug-and-play solution.
The devcontainer specification is MIT licensed.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
  • Loading branch information
gastmaier committed Jan 14, 2025
1 parent 5e82db1 commit ab27afa
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"image": "python:latest",
"name": "Documentation codespace (adi_doctools)",
"customizations": {
"codespaces": {
"openFiles": ["docs/index.rst"]
}
},
"features": {
"ghcr.io/devcontainers/features/git-lfs:1": {}
},
"waitFor": "onCreateCommand",
"updateContentCommand": "python -m venv venv ; source venv/bin/activate ; pip install -r docs/requirements.txt",
"postCreateCommand": "",
"postAttachCommand": {
"server": "source venv/bin/activate ; (cd docs ; adoc serve -p 8000)"
},
"portsAttributes": {
"8000": {
"label": "livel-editor",
"onAutoForward": "openPreview"
}
},
"forwardPorts": [8000]
}

0 comments on commit ab27afa

Please sign in to comment.