Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions .github/workflows/manual.yml → .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,35 @@
name: Build manual
name: Docs

# Trigger the workflow on push or pull request or manually
# Trigger the workflow on push or pull request
on:
workflow_dispatch:
push:
branches:
- main
- master
pull_request:

# the `concurrency` settings ensure that not too many CI jobs run in parallel
concurrency:
# group by workflow and ref; the last slightly strange component ensures that for pull
# requests, we limit to 1 concurrent job, but for the master branch we don't
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }}
# requests, we limit to 1 concurrent job, but for the default repository branch we don't
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_name != github.event.repository.default_branch || github.run_number }}
# Cancel intermediate builds, but only if it is a pull request build.
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
# The documentation job
manual:
name: Build manuals
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v6
- uses: gap-actions/setup-gap@v2
with:
GAP_PKGS_TO_BUILD: "io" # exclude profiling, i.e., *this* package
- uses: gap-actions/build-pkg-docs@v1
- uses: gap-actions/setup-gap@v3
- uses: gap-actions/build-pkg-docs@v2
with:
use-latex: 'true'
- name: 'Upload documentation'
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: manual
archive: false
path: ./doc/manual.pdf
if-no-files-found: error
3 changes: 1 addition & 2 deletions doc/tutorial.autodoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@ f := function() Intersection(a,b); end;
]]></Listing>

Firstly, we will record a profile of the function <C>f</C>:
With this, the code between <C>ProfileLineByLine</C> and <C>UnprofileLineByLine</C> is recorded to a file <F>output.gz</F>.

<Listing><![CDATA[
# Code between ProfileLineByLine and UnprofileLineByLine is recorded
# to a file output.gz
ProfileLineByLine("output.gz"); f(); UnprofileLineByLine();
]]></Listing>

Expand Down