Skip to content

Commit 3b02bb6

Browse files
committed
Reorganiza la generación del HTML y crea el workflow para GitHub Actions
1 parent 674e317 commit 3b02bb6

File tree

2,348 files changed

+53
-269431
lines changed

Some content is hidden

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

2,348 files changed

+53
-269431
lines changed

.github/workflows/docs.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Construir y desplegar el manual
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
7+
jobs:
8+
build-and-deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Obtención de la documentación
12+
uses: actions/checkout@v4
13+
14+
- name: Configurar Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: '3.x'
18+
19+
- name: Instalación de dependencias.
20+
run: |
21+
pip install -r requirements.txt
22+
23+
- name: Construir documentación
24+
run: |
25+
make html
26+
touch docs/html/.nojekyll
27+
28+
- name: Desplegarla en GitHub Page
29+
uses: peaceiris/actions-gh-pages@v3
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: ./docs/html
33+
34+
- name: Notificación
35+
if: success()
36+
uses: actions/github-script@v6
37+
with:
38+
script: |
39+
github.rest.repos.createCommitComment({
40+
owner: context.repo.owner,
41+
repo: context.repo.repo,
42+
commit_sha: "${{ github.sha }}",
43+
body: "¡Doc actualizada: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"
44+
})

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
TODO
2-
src/build
3-
linuxnomicon.tar.xz
2+
docs/
43
**.swp
54
**.bak
65
**.mypy_cache

src/Makefile renamed to Makefile

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,16 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
5+
SPHINXOPTS ?=
6+
SPHINXBUILD ?= sphinx-build
77
SOURCEDIR = source
8-
BUILDDIR = build
9-
PKGDIR = ..
8+
BUILDDIR = docs
109

1110
# Put it first so that "make" without argument is like "make help".
1211
help:
1312
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1413

15-
.PHONY: help html Makefile pkg
16-
17-
html:
18-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
19-
20-
pkg:
21-
@echo -n "Creando paquete de copia en el directorio padre... "
22-
@tar -acf "${PKGDIR}/linuxnomicon.tar.gz" "${SOURCEDIR}"
23-
@echo "Hecho."
14+
.PHONY: help Makefile
2415

2516
# Catch-all target: route all unknown targets to Sphinx using the new
2617
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/.buildinfo

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

docs/01.unix/index.html

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

docs/02.conbas/01.preliminares/index.html

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

docs/02.conbas/02.informacion/01.filesystem.html

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

docs/02.conbas/02.informacion/03.ficheros.html

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

docs/02.conbas/02.informacion/04.devices.html

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

docs/02.conbas/02.informacion/index.html

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

0 commit comments

Comments
 (0)