summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2022-03-08 18:15:52 +0530
committerArun Isaac2022-03-08 18:15:52 +0530
commitafba9bc7d2927c3a31c6b46d75c1b63b598d2776 (patch)
treefb82d8b4d97f869d091aa0d0c33d21d971018b31 /doc
parentcb7cecae3f6152052bdaf601eb1f6fcb2727b6b9 (diff)
downloadguix-forge-afba9bc7d2927c3a31c6b46d75c1b63b598d2776.tar.gz
guix-forge-afba9bc7d2927c3a31c6b46d75c1b63b598d2776.tar.lz
guix-forge-afba9bc7d2927c3a31c6b46d75c1b63b598d2776.zip
doc: Reference source files inside guix directory.
The source files are now nested one level deeper in the guix directory, and the references to the source files in the documentation need to be updated. * doc/forge.skb (Reference): Reference source files inside guix directory.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index b8cb1fe..dae6aaa 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -149,12 +149,12 @@ repeated below for your reference.])
:file "doc/snippets/tutorial.scm")))
(chapter :title [Reference]
(description
- (record-documentation "forge/forge.scm" '<forge-configuration>
+ (record-documentation "guix/forge/forge.scm" '<forge-configuration>
(record-field "projects"
[List of ,(ref :mark "<forge-project>" :text
(code [<forge-project>])) objects describing projects managed by
guix-forge]))
- (record-documentation "forge/forge.scm" '<forge-project>
+ (record-documentation "guix/forge/forge.scm" '<forge-project>
(record-field "name"
[Name of the project])
(record-field "repository"
@@ -195,14 +195,14 @@ and ,(code ['cron]) for remote repositories])
(record-field "repository-branch"
[Main branch of the repository. This field is currently
unused unused, and may be deprecated in the future.]))
- (record-documentation "forge/laminar.scm" '<forge-laminar-job>
+ (record-documentation "guix/forge/laminar.scm" '<forge-laminar-job>
(record-field "name"
[Name of the job])
(record-field "run"
[G-expression to be run])
(record-field "after"
[G-expression to be run after the main job script]))
- (record-documentation "forge/webhook.scm" '<webhook-configuration>
+ (record-documentation "guix/forge/webhook.scm" '<webhook-configuration>
(record-field "package"
[,(code [webhook]) package to use])
(record-field "ip"
@@ -214,7 +214,7 @@ unused unused, and may be deprecated in the future.]))
(record-field "hooks"
[List of ,(ref :mark "<webhook-hook>" :text (code
[<webhook-hook>])) objects describing hooks to configure]))
- (record-documentation "forge/webhook.scm" '<webhook-hook>
+ (record-documentation "guix/forge/webhook.scm" '<webhook-hook>
(record-field "id"
[Identifier of the webhook. This hook is triggered at ,(ref
:url [http://host:port/hooks/<id>]).])