diff --git a/.github/workflows/manual.yml b/.github/workflows/docs.yml similarity index 59% rename from .github/workflows/manual.yml rename to .github/workflows/docs.yml index 4b4d6f0..01986db 100644 --- a/.github/workflows/manual.yml +++ b/.github/workflows/docs.yml @@ -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 diff --git a/doc/tutorial.autodoc b/doc/tutorial.autodoc index 9f3a39f..8a94934 100644 --- a/doc/tutorial.autodoc +++ b/doc/tutorial.autodoc @@ -18,10 +18,9 @@ f := function() Intersection(a,b); end; ]]> Firstly, we will record a profile of the function f: +With this, the code between ProfileLineByLine and UnprofileLineByLine is recorded to a file output.gz.