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
23 changes: 14 additions & 9 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ jobs:
docs:
name: Typeset documentation
runs-on: ubuntu-latest
container:
image: texlive/texlive:TL2023-historic
permissions:
contents: write
steps:
Expand All @@ -21,18 +19,25 @@ jobs:
- name: Install additional packages
run: |
set -ex
apt -qy update
apt -qy install --no-install-recommends parallel
sudo apt -qy update
sudo apt -qy install --no-install-recommends parallel
- name: Install TeX Live
uses: teatimeguest/setup-texlive-action@v3
with:
packages: |
scheme-basic
package-file: |
**/DEPENDS.txt
- name: Typeset documentation
run: |
set -ex
export TEXMFHOME=../../texmf
parallel --halt now,fail=1 -- latexmk -r docs/latexmkrc -cd ':::' docs/*/*.tex
export TEXMFHOME="$PWD"/texmf
find docs/ -type f -name '*.tex' | parallel --halt now,fail=1 -- latexmk -r docs/latexmkrc -cd
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: docs
path: docs/*/*.pdf
name: Documentation
path: docs/**/*.pdf
- name: Create a prerelease
if: github.ref == 'refs/heads/main'
uses: marvinpinto/action-automatic-releases@latest
Expand All @@ -41,4 +46,4 @@ jobs:
automatic_release_tag: latest
prerelease: true
repo_token: ${{ secrets.GITHUB_TOKEN }}
files: docs/*/*.pdf
files: docs/**/*.pdf
1 change: 1 addition & 0 deletions docs/DEPENDS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
latexmk
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
\documentclass{expl3check/warnings-and-errors}
\begin{markdown*}{snippet=witiko/expl3check/warnings-and-errors/metadata}
\documentclass{expltools/explcheck/warnings-and-errors}
\begin{markdown}[snippet=metadata]
title: Warnings and errors for the expl3 analysis tool
author: Vít Starý Novotný
\end{markdown*}
\end{markdown}
\begin{document}
\tableofcontents
\clearpage
\setcounter{secnumdepth}{0}
\markdownSetup{snippet=witiko/expl3check/warnings-and-errors/body}
\markdownSetup{snippet=body}
\markdownInput{00-introduction.md}
\setcounter{secnumdepth}{1}
\markdownInput{01-preprocessing.md}
Expand Down
13 changes: 0 additions & 13 deletions texmf/tex/latex/expl3check/warnings-and-errors.cls

This file was deleted.

8 changes: 8 additions & 0 deletions texmf/tex/latex/expltools/explcheck/DEPENDS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
biber
biblatex
embedfile
hyperref
imakeidx
lua-widow-control
markdown
minted
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesExplPackage
{markdownthemewitiko_expl3check_warnings-and-errors}%
{2024-06-24}%
{0.0.1}%
{Snippets for typesetting the documentation of the warnings and errors for the expl3check tool}
{markdownthemewitiko_expltools_explcheck_warnings-and-errors.sty}%
{2024-07-04}%
{0.0.2}%
{Snippets for typesetting the documentation of the warnings and errors for the expl3 analysis tool}
\int_new:N
\g_subsection_int
\g__expltools_explcheck_subsection_int
\tl_new:N
\g_subsection_tl
\g__expltools_explcheck_subsection_tl
\tl_new:N
\l_current_label_tl
\l__expltools_explcheck_current_label_tl
\tl_new:N
\l_current_identifier_tl
\l__expltools_explcheck_current_identifier_tl
\prop_new:N
\g_labels_prop
\g__expltools_explcheck_labels_prop
\cs_new:Nn
\increment_counters:
\__expltools_explcheck_increment_counters:
{
\int_gincr:N
\g_subsection_int
\g__expltools_explcheck_subsection_int
\int_compare:nTF
{ \g_subsection_int < 10 }
{ \g__expltools_explcheck_subsection_int < 10 }
{
\tl_gset:Nn
\g_subsection_tl
\g__expltools_explcheck_subsection_tl
{ 0 }
\tl_gput_right:NV
\g_subsection_tl
\g_subsection_int
\g__expltools_explcheck_subsection_tl
\g__expltools_explcheck_subsection_int
}
{
\tl_gset:NV
\g_subsection_tl
\g_subsection_int
\g__expltools_explcheck_subsection_tl
\g__expltools_explcheck_subsection_int
}
\tl_if_empty:NF
\l_current_identifier_tl
\l__expltools_explcheck_current_identifier_tl
{
\prop_gput:NVV
\g_labels_prop
\l_current_identifier_tl
\l_current_label_tl
\g__expltools_explcheck_labels_prop
\l__expltools_explcheck_current_identifier_tl
\l__expltools_explcheck_current_label_tl
\exp_args:NV
\label
\l_current_identifier_tl
\l__expltools_explcheck_current_identifier_tl
}
\exp_args:NV
\index
\l_current_label_tl
\l__expltools_explcheck_current_label_tl
}
\markdownSetupSnippet
{ metadata }
Expand All @@ -62,7 +62,7 @@
content_blocks,
definition_lists,
fenced_code,
footnotes,
notes,
header_attributes,
html,
raw_attribute,
Expand Down Expand Up @@ -108,7 +108,7 @@
\l_tmpa_tl
{ ] }
\prop_get:NVN
\g_labels_prop
\g__expltools_explcheck_labels_prop
\l_tmpb_tl
\l_tmpb_tl
\tl_put_right:Nx
Expand All @@ -121,10 +121,10 @@
headingOne = {
\section { #1 }
\int_gset:Nn
\g_subsection_int
\g__expltools_explcheck_subsection_int
{ 0 }
\tl_gset:Nn
\g_subsection_tl
\g__expltools_explcheck_subsection_tl
{ 00 }
},
headerAttributeContextBegin = {
Expand All @@ -134,33 +134,33 @@
renderers = {
attributeIdentifier = {
\tl_set:Nn
\l_current_identifier_tl
\l__expltools_explcheck_current_identifier_tl
{ ##1 }
},
attributeClassName = {
\tl_set:Nx
\l_current_label_tl
\l__expltools_explcheck_current_label_tl
{
\str_uppercase:n { ##1 }
\thesection
\g_subsection_tl
\g__expltools_explcheck_subsection_tl
}
\markdownSetup
{
renderers = {
headingTwo = {
\subsection
{
####1~[ \l_current_label_tl ]
####1~[ \l__expltools_explcheck_current_label_tl ]
}
\increment_counters:
\__expltools_explcheck_increment_counters:
},
headingThree = {
\subsubsection
{
####1~[ \l_current_label_tl ]
####1~[ \l__expltools_explcheck_current_label_tl ]
}
\increment_counters:
\__expltools_explcheck_increment_counters:
},
},
}
Expand All @@ -172,4 +172,4 @@
\group_end:
},
},
}
}
21 changes: 21 additions & 0 deletions texmf/tex/latex/expltools/explcheck/warnings-and-errors.cls
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass%
{warnings-and-errors}%
[2024-07-04 0.0.2 Documentation for typesetting the documentation of the warnings and errors for the expl3 analysis tool]
\LoadClass{article}
\RequirePackage{lua-widow-control}
\RequirePackage{minted}
\setminted{breaklines, linenos}
\RequirePackage{markdown}
\markdownSetup {
import = {
witiko/expltools/explcheck/warnings-and-errors = {metadata, body},
}
}
\RequirePackage{biblatex}
\addbibresource{warnings-and-errors.bib}
\RequirePackage{embedfile}
\RequirePackage{imakeidx}
\makeindex[columns=3, intoc, options=-s warnings-and-errors.ist]
\RequirePackage{hyperref}
\def\meta#1{$\langle$\textrm{\textit{#1}}$\rangle$}
18 changes: 18 additions & 0 deletions texmf/tex/latex/markdown/DEPENDS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
amsfonts
amsmath
catchfile
csvsimple
epstopdf-pkg
etoolbox
fancyvrb
gobble
graphics
grffile
latex
ltxcmds
paralist
pgf
soul
tools
url
verse