Compare commits

...

3 commits

Author SHA1 Message Date
7f5f05ef2b WIP
Some checks failed
/ test (push) Failing after 12s
2025-06-24 20:58:25 +02:00
7c2c6f2de9 WIP 2025-06-24 20:58:25 +02:00
1b7732c958 Add manual index 2025-06-24 20:58:04 +02:00
2 changed files with 118 additions and 0 deletions

View file

@ -0,0 +1,22 @@
on:
push:
branches:
- actions-test
jobs:
test:
runs-on: host
steps:
- run: git clone --depth=1 https://$FORGEJO_TOKEN@forge.cbaines.net/cbaines/guile-knots.git knots-trunk
- run: git clone --depth=1 https://$FORGEJO_TOKEN@forge.cbaines.net/cbaines/guile-knots.git --branch=pages knots-pages
- run: |
cd knots-trunk
guix shell -D -f guix-dev.scm -- documenta api knots
guix shell texinfo -- makeinfo --css-ref=https://luis-felipe.gitlab.io/texinfo-css/static/css/texinfo-7.css --no-split --html -o pages/index.html doc/index.texi
- run: |
cd knots-pages
git add .
git config user.email <>
git config user.name "Automatic website updater"
git commit -m "Automatic website update"
git push

96
doc/index.texi Normal file
View file

@ -0,0 +1,96 @@
\input texinfo
@setfilename guile-knots
@c HEADER
@settitle Guile Knots
@documentlanguage en
@documentencoding UTF-8
@afourpaper
@c END HEADER
@c MASTER MENU
@node Top
@top Overview
Guile Knots is a library providing tools and patterns for programming
with @url{https://github.com/wingo/fibers, Guile Fibers}. Guile Knots
provides higher level building blocks for writing programs using Guile
Fibers, including managing code that can't run in a thread used by
fibers. Also included is a web server implementation using Fibers,
which while being similar to the web server provided by Fibers, can
provide some benefits in specific circumstances.
@c END MASTER MENU
@c TABLE OF CONTENTS
@contents
@c END TABLE OF CONTENTS
@c CHAPTER: API
@include api/index.texi
@c END CHAPTER: API
@c APPENDICES
@node Version History
@appendix Version History
@table @dfn
@item Version 0.Y.0, Month DD, 20YY
@itemize
@item
No initial release has yet been made.
@end itemize
@end table
@node Copying Information
@appendix Copying Information
Copyright © 2024, 2025 Christopher Baines <mail@@cbaines.net>
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 3 of the
License, or (at your option) any later version.
@c END APPENDICES
@c INDICES
@node Concept Index
@unnumbered Concept Index
@printindex cp
@node Data Type Index
@unnumbered Data Type Index
@printindex tp
@node Procedure Index
@unnumbered Procedure Index
@printindex fn
@node Variable Index
@unnumbered Variable Index
@printindex vr
@c END INDICES
@bye