v0.27.0

Documenter v0.27.0

Diff since v0.26.3

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

Closed issues:

• epub backend (#371)
• Automatic noindex tags on versioned docs? (#1302)
• Source link in expanded docstring redirect to Base (#1374)
• Build hanging (#1414)
• Add "this version is outdated" notice to versions other than latest (#1449)
• Fix preview cleanup script for non-existing preview directory (#1499)
• Build hanging on Turing sample call (#1514)
• Preview PR triggering on external PRs on GHA (#1534)
• Use URI-encoding for SVG images coming from at-example blocks (#1537)
• xpath root node question (#1550)
• Doctest syntax error, how to find out where? (#1556)
• Is it possible to switch different pictures in light/dark mode? (#1560)
• Default font for REPL "output" produces poor alignment w/ box-drawing unicode (#1561)
• Improve documentation using packages in doctests for display (#1564)
• Suggestion: Citations from DocumenterCitations.jl (#1587)

Merged pull requests:

• put svg with xmlns in img src tag (#1538) (@jkrumbiegel)
• Illusrtate submodules in @autodocs example (#1541) (@goretkin)
• Refactor sandbox module creation (#1544) (@mortenpi)
• Update SSH deploy example (#1545) (@staticfloat)
• Update doctests.md (#1546) (@glwhart)
• Use IOCapture v0.2 (#1549) (@mortenpi)
• Fix highlight.js warning due to invalid "language-none" (#1551) (@kimikage)
• Two doc updates for PDF output (#1552) (@jaakkor2)
• Let sitename link back to document root just like the logo. (#1553) (@fredrikekre)
• Showcase automatic signature highlighting (#1555) (@mortenpi)
• Handle faulty doctest keyword arguments better (#1557) (@mortenpi)
• Update preview cleanup action (#1558) (@devmotion)
• Update from analytics.js to gtag.js (#1559) (@mlubin)
• Fix a code block on man/hosting.md (#1566) (@mortenpi)
• Check via GitHub API if PR is from same repo for PR preview on GHA (#1567) (@mortenpi)
• Add headers to the admonitions for indexing (#1574) (@logankilpatrick)
• Add warning for outdated docs (#1577) (@pfitzseb)
• fix typo in showcase (#1581) (@ranocha)
• Add note about Plots.jl with GR backend (#1583) (@ranocha)
• Change Julia v1.4 -> v1.6 in Travis CI/Github Actions workflows (#1586) (@navidcy)
• Adds GeophysicalFlows.jl in Registered packges (#1588) (@navidcy)
• Fix links to fix linkcheck (#1589) (@mortenpi)
• Set version to 0.27.0 (#1590) (@mortenpi)
• remove note in README about pre 1.0 versions (#1592) (@KristofferC)

v0.26.3

Documenter v0.26.3

Diff since v0.26.2

A maintenance release preparing Documenter for upcoming changes on Julia master. The changes are documented in the CHANGELOG.md file.

Closed issues:

• Don't know why travis is being used. (#1530)
• Throw an error if repo contains a protocol (#1531)
• Flaky Tests during local development (#1535)
• Images can get larger than the container in HTML (#1539)

Merged pull requests:

• Remove unused fallback method for post_status (#1528) (@mortenpi)
• Make deploydocs throw if push fails (#1529) (@mortenpi)
• Thrown an error if the repo path contains the protocol (#1533) (@giordano)
• use valid identifiers for sandbox module names (#1540) (@JeffBezanson)
• Backports for 0.26.3 (#1543) (@mortenpi)

v0.26.2

Documenter v0.26.2

Diff since v0.26.1

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

Closed issues:

• missing methods with common documentation (#705)
• error in jldoctest with # output followed by no-newline (#765)
• GitHub Pages build not triggered with GITHUB_TOKEN (#1177)
• Error: mode == :single requires the Markdown string to parse into a single block │ (#1387)
• Move CI from Travis to GitHub Actions? (#1487)
• Wrong docstring displayed for overloaded functions (#1502)
• Deploying failure (#1505)
• Fix Edit source button (#1508)
• Clarify treatment of outputs (streams, # hide and semicolon) (#1509)
• "Permission denied" when running doctests from runtests.jl (#1513)
• Get tests passing on GitHub Actions Windows runners (#1516)

Merged pull requests:

• Switch CI over to GitHub Actions (#1496) (@mortenpi)
• Add short section on logos (#1498) (@cormullion)
• Update highlightjs version (#1503) (@laborg)
• Fix crash in case of empty # output (#1510) (@knuesel)
• Check for empty CI environment variables (#1511) (@knuesel)
• Clarify treatment of outputs (#1512) (@knuesel)
• Remove GitHub token build trigger warning (#1517) (@knuesel)
• Fix multiline display equations in HTML (#1518) (@odow)
• Normalize line breaks before replacements (#1519) (@odow)
• Fix cross-platform newline handling in doctests (#1520) (@mortenpi)
• fix typo in hosting.md (#1524) (@rfourquet)
• Backports for 0.26.2 (#1525) (@mortenpi)
• Just warn if doctest() fails to clean up (#1526) (@mortenpi)
• A few PDF improvements (#1527) (@jebej)

v0.26.1

Documenter v0.26.1

Diff since v0.26.0

Bugfix release. The changes are documented in the CHANGELOG.md file.

Merged pull requests:

• Create new files instead of copying internal resources. (#1497) (@fredrikekre)

v0.26.0

Documenter v0.26.0

Diff since v0.25.5

Feature release bringing various enhancements and semi-breaking changes related to the PDF/LaTeX backend. The changes are documented in the CHANGELOG.md file.

Closed issues:

• deploydocs default to devbranch="master", although github default branch is main now. (#1485)
• Stable version points to an old tag (#1488)

Merged pull requests:

• Print a warning when main/master confusion detected (#1489) (@mortenpi)
• A few non-functional maintenance changes (#1490) (@mortenpi)
• Throw an error early in HTMLWriter when there are no pages (#1491) (@mortenpi)
• Set version to 0.26.0 (#1492) (@mortenpi)
• Un-deprecate built-in PDF/LaTeX output (#1493) (@mortenpi)

v0.25.5

Documenter v0.25.5

Diff since v0.25.4

A bugfix release. The changes are documented in the CHANGELOG.md file.

Closed issues:

• Long math ... overflows the div (#1470)
• ERROR: UndefVarError: par not defined. when using makedocs() (#1482)
• Wrong Math format for inline math in lists (#1483)

Merged pull requests:

• Scroll overflow for long equations (#1476) (@friggog)
• Fix CHANGELOG on master (#1480) (@mortenpi)
• Backports for 0.25.5 (#1484) (@mortenpi)

v0.25.4

Documenter v0.25.4

Diff since v0.25.3

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

Closed issues:

• Searching for @DIR (#720)
• "text/latex" output not rendered (#1278)
• Respect users' preference for light/dark mode (#1320)
• Coverage reports of Documenter.jl's tests have not been sent (#1459)
• Add support for Azure DevOps url scheme (#1462)
• The @autodocs macro treats Unions as constants (#1466)

Merged pull requests:

• Strip out $$ as well (#1426) (@blegat)
• Respect user preference for color scheme (#1456) (@abhishalya)
• Fix codecov upload (#1460) (@mortenpi)
• docs: cleaning up PR previews (#1461) (@ericphanson)
• Update TagBot.yml (#1465) (@mortenpi)
• Add page title to search results (#1468) (@ianshmean)
• Add support for deploying from Buildkite. (#1469) (@maleadt)
• Add support for Azure DevOps repos (#1471) (@friggog)
• Stop warning for mailto: links (#1472) (@friggog)
• List Union{...} type aliases as "Type" (#1474) (@mortenpi)
• Don't run additional build stages on nightly (#1477) (@mortenpi)
• Backports for 0.25.4 (#1478) (@mortenpi)
• Fix the tests on nightly (#1479) (@mortenpi)

v0.25.3

Documenter v0.25.3

Diff since v0.25.2

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

Closed issues:

• Defining LaTeX commands in a single location for use throughout the docs (#532)
• Canonical URLs without index.html (#1035)
• add example to @docs for type & multiple constructors (#1361)
• How to specify doctestfilters for the function doctest? (#1364)
• zeptodoctor appears as contributor when using Documenter.jl (#1379)
• Add code coverage from deployed docs? (#1397)
• Include files generated by examples in deployment (#1404)
• Trouble with docstrings from included file in module (#1406)
• Allow <!--- ... --> as markdown comment (#1409)
• Documentation unacessible (#1421)
• tex macro for MathJax3 (#1427)
• script.src for MathJax3 (#1428)
• LaTeX fraction not rendering properly in md files (#1432)
• Heavy slowdown in ExpandTemplates due to subtypes function (#1438)

Merged pull requests:

• Add example of code coverage to docs (#1399) (@briochemc)
• Clarify the docstring of lang keyword (#1407) (@mortenpi)
• simple typo fix "rather then" to "rather than" (#1415) (@vlandau)
• Replace Utilities.withoutput with IOCapture (#1422) (@mortenpi)
• Add a showcase example for multiple uses of the same symbol. (#1425) (@tpapp)
• Allow specifying URLs for LaTeX engines (#1430) (@ianqsong)
• Correctly accept doctestfilters kwarg in Documenter.doctest (#1435) (@fredrikekre)
• Set version to 0.25.3 (#1439) (@mortenpi)
• Cache subtypes to speed up selector dispatch (#1440) (@epatters)
• Update links (#1442) (@kimikage)
• Add Gitlab deployconfig. (#1448) (@MichaelHatherly)
• Empty Selector cache before running build pipeline (#1452) (@mortenpi)
• Do not capture interrupts with iocapture() (#1453) (@mortenpi)

v0.25.2

Documenter v0.25.2

Diff since v0.25.1

Closed issues:

• Doctest fixing broken on Julia 1.5/nightly (#1337)
• Add MathJax3 Writer (#1362)
• "Edit on Github" link points to master instead of custom devbranch (#1375)
• Test Failure on Julia 1.5 (#1378)
• Searching for a page title fails to find (#1380)
• make.jl never ends (#1382)
• deploydocs thinks it's on Travis when it's on Github Actions (#1391)

Merged pull requests:

• MathJax3 support (#1367) (@simeonschaub)
• Doctest output starting with # (#1369) (@mortenpi)
• Fix typo: it's structure -> its structure (#1381) (@zdroid)
• Add LiveServer.jl as an option for running a local web server (#1383) (@DilumAluthge)
• Merge nested li statements in SCSS (#1384) (@zdroid)
• Use shorter LiveServer invocation in docs (#1385) (@DilumAluthge)
• Simplify some SCSS styles (#1386) (@zdroid)
• Retire zeptodoctor (#1388) (@mortenpi)
• Work around 1.5 & nightly test failures (#1389) (@mortenpi)
• Correct render code block with tag "```julia-repl XXX" (#1392) (@likanzhan)
• Simplify assets/mkdocs/Documenter.css (#1395) (@zdroid)
• Move latexinline out of if-else-end (#1396) (@zdroid)
• Fix the nightly tests (#1398) (@mortenpi)
• Refactor and test code language determination (#1400) (@mortenpi)
• Set version to 0.25.2 (#1402) (@mortenpi)
• Clarify missing docstrings warning/error (#1405) (@mortenpi)

v0.25.1

Documenter v0.25.1

Diff since v0.25.0

A release with enhancements and minor non-breaking behavior changes. The changes are documented in the CHANGELOG.md file.

Closed issues:

• Highlight output code-blocks differently (#1026)
• Switch fatal warnings to errors if running with strict=true (#1088)
• A customizable footer on generated pages (#1184)
• HTMLWriter: ERROR: UndefRefError: access to undefined reference (#1201)
• Puzzling "Warning: duplicate docs found" (#1366)

Merged pull requests:

• Log @error for any DocCheck which triggers a failure. (#1349) (@simonbyrne)
• If no pages specified, put index.md in front of other pages (#1355) (@mortenpi)
• Add .gitattributes to fix language report (#1356) (@mortenpi)
• Add specific HTML class to example output (#1357) (@tkf)
• Use consistent HTML classs for stdout/err in example (#1360) (@tkf)
• Fix exception handling in test/examples/make.jl (#1363) (@mortenpi)
• Add "Powered by ..." message to footer (#1365) (@pfitzseb)
• align* clashes with split and equation* (#1368) (@likanzhan)
• Set version to 0.25.1 (#1372) (@mortenpi)