Skip to content

Latest commit

 

History

History
402 lines (267 loc) · 18.7 KB

ChangeLog.md

File metadata and controls

402 lines (267 loc) · 18.7 KB
Raw

ChangeLog

0.20.1 (2024-12-14)

  • Fixed dependency from swank-backend package for autodoc package.

0.20.0 (2024-12-14)

0.19.0 (2024-12-13)

  • Argument IGNORE-PACKAGES was added to 40ants-doc/autodoc:defautodoc macro. It can be used to exclude some packages from autogenerated docs.
  • Image URLs now can be specified relative to some other ASDF system. For example ![](asdf:some-other-system:images/demo.gif) will look for the image inside the directory ofsome-other-system ASDF` system.

0.18.0 (2024-08-29)

  • Now default theme looks good on mobile devices.

0.17.4 (2024-05-15)

  • Update 5

0.17.3 (2024-05-15)

  • Update 2

0.17.2 (2024-05-15)

  • Another update.

0.17.1 (2024-05-15)

  • Just a check if tag will be added automatically.

0.17.0 (2024-05-13)

Backward incompatible

0.16.0 (2024-05-04)

0.15.4 (2024-01-26)

  • Another fix to URLs on the search page. Now if CLEAN-URLS argument is true, search page will link to the pages ended with a backslash. Otherwise, it will link to the html pages.

0.15.3 (2024-01-24)

  • Fixed URLs in the search index file when CLEAN-URLS argument is given. This should prevent redirection to index.html file from search page - now index.html will be stripped from the path.

0.15.2 (2023-11-28)

  • Fixed stack exhausting when trying to collect dependencies for some ASDF systems.

0.15.1 (2023-08-05)

  • Fixed issue with unpacking Highlight.js archive when it is having absolute pathnames.

Also, a new download API is used now.

0.15.0 (2023-07-22)

  • Autodoc was fixed to not show packages without external symbols.
  • Also, now autodoc sorts packages alphabetically.

0.14.0 (2023-06-04)

This might be useful for autogenerated methods. For example, Mito does generate such reader methods here.

0.13.0 (2023-06-04)

  • Support for variables was added to autodoc subsystem.

0.12.0 (2023-04-22)

  • Autodoc subsystem was added. It provides a 40ants-doc/autodoc:defautodoc macro which can build an API reference for a given ASDF system.
  • Now we output a list of dependencies for an ASDF system description.

0.11.2 (2022-12-05)

  • Script on the search page was fixed.

0.11.1 (2022-11-26)

0.11.0 (2022-11-16)

  • Large refactoring was introduced. All files related to the documentation builder were moved to ./full/ folder and corresponding packages was renamed to have 40ants-doc-full/ prefix.

0.10.0 (2022-11-09)

  • Default theme was reworked and now uses divs and flex for rendering "bullets". Also, bullets were made more structured and now it is more convenient to change their design using CSS.

0.9.2 (2022-10-26)

  • Fixed a few issues with ASDF and warnings from find-system generic-function:
Computing just-done stamp  for action (ASDF/LISP-ACTION:COMPILE-OP
  "40ants-asdf-system/changelog"), but dependency (ASDF/LISP-ACTION:COMPILE-OP
  "40ants-asdf-system/changelog"
  "file-type") wasn't done yet!

0.9.1 (2022-10-19)

  • Fixed 40ants-doc asdf system dependency from the 40ants-doc/ignored-words. Because this module should be in the core system.

0.9.0 (2022-02-21)

  • Now you can refer internal documentation section of other libraries. To do this, put the link to this library documentation to the EXTERNAL-DOCS argument of 40ants-doc:defsection macro and then mention other section like this: 40ANTS-CI::@CRITIC section.

0.8.0 (2022-02-14)

0.7.0 (2021-12-31)

  • 40ants/changelog:defchangelog now supports EXTERNAL-LINKS argument.
  • Automatic symbol extraction now ignores dates like 2021-12-31. Now to make it work, the symbol should contain at least one alpha character.

0.6.0 (2021-12-05)

  • Fixed the issue, when we tried to find uppercased xrefs inside inline code and links.
  • Added EXTERNAL-LINKS argument to defsection macro. It can be useful, if you have a multiple text sections having the same external link.
  • Now it is possible to use 40ants-doc/ignored-words:ignore-words-in-package to suppress warning on symbols which are exported but not documented.

0.5.8 (2021-10-23)

  • Fixed the way of how a TOC is built. Previosly it incorrectly shown nested COMMONDOC:SECTION objects.

0.5.7 (2021-10-21)

  • defsection macro now supports EXTERNAL-DOCS argument.

0.5.6 (2021-10-21)

  • Blockquotes markup is supported now.
  • Now external references are rendered as code and downcased according to the settings.

0.5.5 (2021-09-26)

Warning messages like:

Unable to find target for reference #<XREF 40ANTS-DOC/COMMONDOC/XREF:XREF> mentioned at ChangeLog / 0.5.3  (2021-09-08)

were rewritten to be more actionable:

Object referenced as #<XREF 40ANTS-DOC/COMMONDOC/XREF:XREF> in ChangeLog / 0.5.3  (2021-09-08) is not documented.

0.5.4 (2021-09-11)

  • Included changelog.lisp into the 40ants-doc system.

0.5.3 (2021-09-08)

  • Fixed locatives parsing in case if there are more than one 40ANTS-DOC/COMMONDOC/XREF:XREF in the text.

0.5.2 (2021-09-08)

  • Now default theme removes underline from images nested into the <a> HTML tag.
  • Fixed images collection for case when current directory is different from the ASDF system's directory.

0.5.1 (2021-09-07)

  • Fixed reference index generation and comparison of usual references with references where locative is a string.

0.5.0 (2021-09-06)

  • Now 40ants-doc:defsection macro accepts EXTERNAL-DOCS argument. Together with HTML pages, references.json file is rendered, and you can provide a list of urls of external libraries' documentation to have an automatic cross-referencing between them.

0.4.1 (2021-09-05)

0.4.0 (2021-09-05)

0.3.0 (2021-09-04)

  • Now images are copied to target folder together with HTML documentation and links are adjusted accordingly.
  • Added a protocol to define new color themes and change page layout. Three new themes are available out of the box. Read more at Defining a Custom Theme section.

0.2.0 (2021-09-01)

  • Now defsection does not exports symbols by default
  • You can render documents in multiple formats in a single run having cross links. For example shorter README.md could mention symbols and have correct links to the full documentation
  • "Clean" URLs are supported out of the box.
  • Now defsection does not export nor mentioned symbols nor the name of the section It is better to have explicit exports.
  • 40ants-doc/locatives:include locative now does not support :HEADER, :FOOTER and some other arguments. Use :LANG argument instead.
  • Added code highlighting using Highlight.js library.
  • Added search form which uses index in browser. JS code was taken from Sphinx documentation builder.
  • Elisp code for transcriptions was fixed and now should word not only with SLIME, but also with SLY.
  • 40ants-doc:defsection macro now does not generate export code if :EXPORT argument is NIL.
  • Functions UPDATE-ASDF-SYSTEM-HTML-DOCS and UPDATE-ASDF-SYSTEM-README were replaced with 40ants-doc-full/builder:update-asdf-system-docs, which also supports ChangeLog.md generation. Use 40ants-doc/changelog:defchangelog to define versions.
  • Variables *DOCUMENT-HTML-MAX-NAVIGATION-TABLE-OF-CONTENTS-LEVEL* and *DOCUMENT-MAX-TABLE-OF-CONTENTS-LEVEL* were removed. Probably we'll return this feature back in other form, to restrict TOC's size.
  • Removed LOCATE-AND-DOCUMENT generic function.
  • Links to the GitHub now are generated automatically, if 40ants-doc-full/builder:update-asdf-system-docs function is used and system definition has a :SOURCE-CONTROL slot.
  • Generic functions COLLECT-REACHABLE-OBJECTS and LOCATE-AND-COLLECT-REACHABLE-OBJECTS were removed.
  • Variables *DOCUMENT-LINK-SECTIONS*, *DOCUMENT-TEXT-NAVIGATION* and *DOCUMENT-FANCY-HTML-NAVIGATION* were removed.
  • Variable *DOCUMENT-MIN-LINK-HASH-LENGTH* was removed. Use COMMONDOC-MARKDOWN:*MIN-LINK-HASH-LENGTH*
  • Functions 40ants-doc-full/builder:update-asdf-system-docs and 40ants-doc-full/builder:render-to-files now accept WARN-ON-UNDOCUMENTED-PACKAGES argument and CLEAN-URLS argument.
  • Variable *DOCUMENT-MARK-UP-SIGNATURES* was removed.
  • Added DOWNCASE-UPPERCASE-CODE argument instead of *DOCUMENT-DOWNCASE-UPPERCASE-CODE*. This argument is true by default.
  • Added warnings on symbols, referenced like internals, using ::.
  • Added 40ants-doc:defsection-copy macro to define copy of the section but with a different name.

0.1.0 (2021-05-01)

  • Project forked from MGL-PAX. Code refactored into the package inferred system and core is separated to have minimum dependencies.
  • Fixed displaying docstring for constant locative.
  • Include locative was fixed for files with unicode characters file-subseq function was rewritten.
  • Locatives can be specified without a package prefix inside the defsection because all locative symbols now live in 40ants-doc/locatives package.
  • Function update-asdf-system-readmes was renamed to update-asdf-system-readmes and now it generates only one README file.
  • Tests were rewritten to use Rove and to support (asdf:test-system :40ants-doc).
  • Removed MGL-PAX:DEFINE-PACKAGE macro. An UIOP:DEFINE-PACKAGE can be used instead.
  • Now builder issues a warning if it wasn't able to find a symbol mentioned in the docstring.
  • Uppercase word should have at least two charaters to be resolved as a symbol.
  • Improved work with package inferred systems. For examples, when fixed the automatic symbol rendering for case when documentation section and referenced objects are in different packages.
  • Allowed to reference objects using keywords.
  • Fixed docstring extraction for compiler macro.
[generated by 40ANTS-DOC]