Documenter

Author: scheinerman

.codecov.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/dependabot.yml

@@ -3,8 +3,9 @@ on:
   push:
     branches:
       - main
-    tags: '*'
+    tags: ['*']
   pull_request:
+  workflow_dispatch:
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
@@ -14,33 +15,27 @@ jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 60
+    permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
+      actions: write
+      contents: read
     strategy:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
+          - '1.10'
           - '1.6'
-          - '1'
+          - 'pre'
         os:
           - ubuntu-latest
-          - windows-latest
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v1
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1

.github/workflows/CI.yml

@@ -4,6 +4,22 @@ on:
     types:
       - created
   workflow_dispatch:
+    inputs:
+      lookback:
+        default: "3"
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'

.github/workflows/TagBot.yml

@@ -0,0 +1,29 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.6'
+      - uses: julia-actions/cache@v2
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

.github/workflows/documentation.yml

@@ -1 +1 @@
-Manifest.toml
+.vscode/*

.gitignore

@@ -1,7 +1,7 @@
 name = "LatexPrint"
 uuid = "d2208f48-c256-5759-9089-c25ed2a93924"
 author = ["Edward Scheinerman <[email protected]>"]
-version = "1.1.0"
+version = "1.1.1"
 
 [deps]
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"

Project.toml

@@ -1,19 +1,11 @@
 # LatexPrint
 
-[![Build Status](https://travis-ci.com/scheinerman/LatexPrint.jl.svg?branch=master)](https://travis-ci.com/scheinerman/LatexPrint.jl)
-
-
 Print Julia objects in LaTeX form.
 
-## Installation
-
-Enter the package manager by typing a close bracket: `]` and then
-```
-pkg> add LatexPrint
-```
+> Instead of seeing `1//3` in your document, you get to have $\frac{1}{3}$. 
 
 
-## Key functions
+## Key Functions
 
 This module provides functions for converting Julia objects into
 string representations for use in LaTeX mathematics mode. The primary
@@ -22,6 +14,7 @@ Julia objects are first converted to a form suitable for
 LaTeX. Because `laprintln` is a lot to type, we also provide the
 abbreviation `lap`.
 
+
 ```
 julia> using LatexPrint
 
@@ -47,11 +40,10 @@ The double backslash in the output of `latex_form` is converted to a
 single backslash when run through a `print` function.
 
 
-## Supported Types
 
-### Numbers
+## Numbers
 
-#### Integers and floating point numbers
+### Integers and floating point numbers
 
 `FloatingPoint` and `Integer` numbers are printed unchanged.
 
@@ -84,7 +76,7 @@ julia> lap(pi)
 \pi
 ```
 
-#### Rational numbers
+### Rational numbers
 
 Rational numbers are printed as fractions (unless the denominator
 happens to be 1, in which case we print as an integer).
@@ -97,7 +89,7 @@ julia> lap(10//2)
 5
 ```
 
-#### Complex numbers
+### Complex numbers
 
 Complex numbers always include a real and an imaginary part, even if
 either part equals zero:
@@ -116,7 +108,7 @@ julia> lap(im^im)
 0.20787957635076193+0.0i
 ```
 
-### Boolean values
+## Boolean Values
 
 The `Bool` values `true` and `false` output like this:
 ```
@@ -127,12 +119,12 @@ julia> lap(false)
 \mathrm{F}
 ```
 
-### `nothing`
+## `nothing`
 
 A `nothing` value is rendered as `\mathrm{nothing}`.
 
 
-### Text
+## Text
 
 The LaTeX version of an `String` is wrapped in the command
 `\text` (which requires the `amsmath` package in LaTeX). The rationale
@@ -146,7 +138,7 @@ julia> lap("Hello, world!")
 
 
 
-### Arrays
+## Arrays
 
 Vectors (one-dimensional arrays) and matrices (two-dimensional arrays)
 are converted into LaTeX `array` environments bounded by square
@@ -203,7 +195,7 @@ julia> lap(x')
 \right]
 ```
 
-### Sets
+## Sets
 
 Julia `Set` and `IntSet` objects are rendered as a comma separated
 list between curly braces. The elements are sorted into ascending
@@ -230,7 +222,7 @@ julia> lap(C)
 \emptyset
 ```
 
-## The `tabular` function
+## The `tabular` Function
 
 If `A` is a matrix (two-dimensional array), then `laprintln(A)` (or
 `lap(A)`) prints the LaTeX code for that matrix (complete with