v0.27.20

Documenter v0.27.20

Diff since v0.27.19

A release with enhancements and bugfixes. The changes are documented in the CHANGELOG.md file.

Closed issues:

• checkdocs=:exports report non-missing docstring as missing (#1204)
• Docstring check confused with reexported function (#1695)
• RFC: Drop support for Julia 1.0-1.5 (#1835)
• Formatting error in Documenter.jl documentation, section on "Custom preamble" (#1837)
• Docs dont mention reduce(... dims) reducedim.jl overload or any overloads? (#1845)
• Make "Extended help" sections in docstrings collapsible (#1852)
• Rebinding Module during DocChecks (#1857)

Merged pull requests:

• Remove Markdown backend from Documenter (#1826) (@mortenpi)
• Raise minimum required Julia version from 1.0 to 1.6 (#1841) (@fredrikekre)
• Refactor getdocs code (#1842) (@mgkurtz)
• Update MathJax to 3.2.2 (#1844) (@rikhuijzer)
• Update JS dependencies to latest non-breaking version (#1846) (@mortenpi)
• Update example link to SimGBS.jl (#1847) (@mortenpi)
• Add folder selection for gh-pages (#1849) (@eirikbrandsaas)
• Add --project to julia --project make.jl (#1850) (@eirikbrandsaas)
• change CI badges from Travis/AV -> GHA (#1853) (@KristofferC)
• Move draft keyword documentation out of the expandfirst (#1854) (@bauglir)
• Fix nightly test failures (#1856) (@mortenpi)
• GHA setup: add statuses write permissions (#1858) (@mortenpi)
• Edit LaTeX customization docs (#1860) (@mortenpi)
• Fix missing doc check for methods from other packages (#1861) (@mortenpi)
• Set GIT_TEMPLATE_DIR when calling Git (#1862) (@mortenpi)
• Change minimum Julia version 1.0 -> 1.6 in README (#1864) (@LilithHafner)
• Allow "deploying" to a tarball (#1865) (@mortenpi)
• Backports for 0.27.20 (#1866) (@mortenpi)

v0.27.19

Documenter v0.27.19

Diff since v0.27.18

Feature and bugfix release. See CHANGELOG.md for notable changes.

Closed issues:

• Feature request: Don't recompile search cache when [enter] is used in search field (#1728)
• Default edit_link to default branch rather than "master" (#1827)

Merged pull requests:

• Set ansicolor default to true (#1828) (@mortenpi)
• Set permissions: content: write in hosting.md (#1829) (@rikhuijzer)
• Automatically determine edit_link default (#1830) (@mortenpi)
• Disable enter key page refresh on search page (#1833) (@IanButterworth)
• Hide sidebar on search (#1834) (@IanButterworth)
• Draft mode that skips (potentially) expensive parts of the build process (#1836) (@fredrikekre)
• Memoize result value in Utilities.getremote (#1838) (@fredrikekre)
• Backports for release 0.27 (#1839) (@fredrikekre)

v0.27.18

Documenter v0.27.18

Diff since v0.27.17

A release with bugfixes and enhancements. The changes are documented in the CHANGELOG.md file.

Closed issues:

• Incorrectly displayed version selector in non-versioned docs (#1667)
• Excessive padding in some cases (bikeshedding) (#1814)
• Build not triggered by TagBot (#1815)
• Using a docstring more than once makes it not show up (#1823)

Merged pull requests:

• improve error message to only print fatal errors (#1816) (@ericphanson)
• Reduce padding in some container elements (#1818) (@mortenpi)
• Set permissions: write-all in hosting.md (#1819) (@rikhuijzer)
• Disable git prompts for ssh remotes, pass through ssh-agent env variables. (#1821) (@fredrikekre)
• Add documentation for LaTeX macros and mathengine (#1822) (@hyrodium)
• Set version to 0.27.18 (#1824) (@mortenpi)
• Fully disable version selector on unversioned docs (#1825) (@mortenpi)

v0.27.17

Documenter v0.27.17

Diff since v0.27.16

A release with bugfixes and enhancements. The changes are documented in the CHANGELOG.md file.

Closed issues:

• UndefVarError when using docstring on functions with type parameters (#1192)
• Use tectonic to build the pdf version of the manual (#1802)
• UndefVarError when using docstring on callable object with return type (#1810)
• GitHub Action documentation.yml template (#1812)

Merged pull requests:

• Add a CI job to verify CHANGELOG (#1800) (@mortenpi)
• LaTeX: add tectonic (#1803) (@barucden)
• Update the warning for dev version docs (#1805) (@ViralBShah)
• Fix LaTeX logs with Docker, merge docs/make.jl scripts (#1806) (@mortenpi)
• Fix linkcheck (again) (#1807) (@mortenpi)
• Set version to 0.27.17 (#1809) (@mortenpi)
• Handle bad doc metadata better in at-autodocs (#1811) (@mortenpi)
• update documentation.yml template (#1813) (@baxmittens)

v0.27.16

Documenter v0.27.16

Diff since v0.27.15

Enhancements and bugfixes. The changes are documented in the CHANGELOG.md file.

Closed issues:

• Newline needed for minted code block in pdf export (#1160)
• pdf can't be created from the compiled .tex file (#1418)
• Ref's not resolving to markdown section (#1733)
• How to include the docstring for a function from another package in my Julia docs? (#1734)
• Documenter unable to recognize certain functions (#1744)
• [FR] New way to customize LaTeX preamble (#1746)
• strict=true fails to change loglevel from Warning to Error (#1756)
• Add Twitter summary card meta tags (#1763)
• Option to show version in sidebar underneath sitename (#1768)
• Markdown2 conversion error for a docstring in BPFnative.API.Network (#1775)
• Unexpected error expanding markdown with CodeTracking.jl's code_string (#1779)
• Monospace font "faux" bolding causing alignment issues in some cases (#1780)
• Documentation for a specific version never builds (#1786)
• Feature: conditionally select images to display based on the active theme (e.g. documenter-light vs. documenter-dark) (#1789)
• Allow customizing deploy subfolder (#1790)
• Sqrt written as √ causes doc build to fail (#1793)

Merged pull requests:

• docerror! to fix #1756 (#1776) (@st--)
• Added QuizQuestion to README (#1783) (@sylvaticus)
• Fix JuliaMono CSS to support all weights/variants (#1784) (@mostol)
• [LaTexWriter] Better spacing between section number and title (#1785) (@ViralBShah)
• Fix issue link references in CHANGELOG.md (#1787) (@mortenpi)
• [TeX] Allow custom preamble (#1788) (@inkydragon)
• TimeMachine.jl -> ClimaTimeSteppers.jl (#1794) (@Saransh-cpp)
• Add version option to LaTeX format (#1795) (@mortenpi)
• Fix outdated GitHub Docs links (#1796) (@mortenpi)
• Disable git terminal prompt when detecting remote HEAD branch. (#1797) (@fredrikekre)
• Set version to 0.27.16 (#1799) (@mortenpi)

v0.27.15

Documenter v0.27.15

Diff since v0.27.14

Feature and bugfix release. See CHANGELOG.md for notable changes.

Closed issues:

• Too much space in multiline @repl block (#1770)
• Allow docs build on schedule (#1772)
• Use Meta refresh instead of symlinks (#1777)

Merged pull requests:

• [tex] Adjusting the TOC style (#1750) (@inkydragon)
• allow deploy docs on schedule (#1773) (@Ianlmgoddard)
• Force code padding (#1774) (@pfitzseb)

v0.27.14

Documenter v0.27.14

Diff since v0.27.13

Bugfix release. See CHANGELOG.md for changes.

Closed issues:

• Failed to decode DOCUMENTER_KEY (#1769)
• Too much space in multiline @repl block (#1770)

Merged pull requests:

• Fix repl-code-block styling (#1771) (@pfitzseb)

v0.27.13

Documenter v0.27.13

Diff since v0.27.12

Bugfix release. See CHANGELOG.md for changes.

Closed issues:

• Issue with Enum (#1157)
• font choice makes \prime look like a single quote (#1408)
• Filters for cross version array printing (#1436)
• Ability to set IOContext in which @example/@repl blocks are run (#1450)
• Option to have source link button always visible? [feature request] (#1548)
• Doctest filter matches line by line by default (#1679)
• gksqt process not ended when building docs locally (#1685)
• “Old documentation” banner shown for pre-release docs (#1726)
• Where is the documentation actually hosted? (#1740)
• Plotting when generating site map? (#1741)
• How do I cite Documenter.jl (#1742)
• "documenting" a course: ok on local, single siteinfo.js file on gh-pages (#1757)
• Code copy button should stay in the top corner when scrolling horizontally (#1758)
• Browser warning for failed loading of copy.js script (#1760)
• How would be possible to add multiple-choice quizzes to documenter ? (#1764)

Merged pull requests:

• Document that doctest filters match line-by-line (#1720) (@odow)
• Fix typos in syntax.md (#1755) (@fkastner)
• Improve pre-code scrolling (#1759) (@pfitzseb)
• Fix copy button script loading (#1762) (@pfitzseb)
• Fix typo of ssh key link (#1765) (@bicycle1885)

v0.27.12

Documenter v0.27.12

Diff since v0.27.11

Closed issues:

• Copy button does't working (#1753)

Merged pull requests:

• Improve copy button JS (#1754) (@pfitzseb)

v0.27.11

Documenter v0.27.11

Diff since v0.27.10

Closed issues:

• Add a root HTML page? (#264)
• Add an example for adding images (#300)
• mkdocs fails in Travis (#405)
• Add sub-headings in table of contents of PDF documentation (#524)
• some (markdown) page <-> Jupyter notebooks conversion? (#692)
• Feature Request: copy to clipboard (#1055)
• macro calls allowed @example blocks? (#1128)
• Fenced code blocks can't be syntax highlighted in Atom (#1163)
• Bold text is hard to distinguish in Chrome on Mac (#1187)
• CSS does not load for Safari in local builds (#1202)
• PDF generation errors on latexinline on symbol (#1214)
• depth controlling argument (#1259)
• Latex does not work when dollar signs are used in a single line (#1276)
• Feature request: cron job that removes old preview subfolders (#1306)
• deprecate devbranch defaulting to master? (#1443)
• Load key: invalid format (#1515)
• Support workflow_dispatch events on GitHub Actions (#1554)
• Add docs on how to create a "Note" section in blue (#1571)
• Design around the "grand unified theory of documentation" (#1606)
• docs should make clear what file GitHub action is in (#1608)
• Suggestion for TagBot.yml file is stale (#1622)
• Notation for simultaneously label a jldoctest block, and giving it a setup = :() ? (#1678)
• Public API - deploydocs - making argument dirname documented (#1682)
• How do I pass the output of @eval @example @repl block to @raw html block (#1713)
• Cryptic error in CI (#1717)
• Building document for a tag on Github (#1729)
• Error "incomplete, "incomplete: premature end of input" while expanding templates (#1731)
• source links not showing in local build (#1732)
• Contrast for 'Note' text boxes in dark mode (#1736)
• TagBot not tagging after adding DOCUMENTER_KEY (#1737)
• Documentation build failing because of Pairs reference in precompile() call (#1738)
• Make doctest report N tests for N jldoctest blocks (#1739)

Merged pull requests:

• Tidy showcase.md and add an example of adding an image (#1718) (@odow)
• Document dirname argument of deploydocs (#1719) (@odow)
• Update suggested TagBot file in documentation (#1721) (@odow)
• Clarify docs for setting up GitHub actions (#1722) (@odow)
• Document collapselevel argument to HTML (#1723) (@odow)
• Adds missing code formatting in docs (#1730) (@navidcy)
• Update MathJax to v3.2.0 (#1743) (@jmert)
• Copy button for code blocks (#1748) (@pfitzseb)
• Figure out default branch using git, fixes #1443, closes #1727. (#1751) (@fredrikekre)
• deploy from workflow_dispatch builds (#1752) (@BeastyBlacksmith)