Fixed stack exhausting when trying to collect dependencies for some
Fixed issue with unpacking Highlight.js archive when it is having absolute pathnames.
Also, a new download
API is used now.
Autodoc was fixed to not show packages without external symbols.
Also, now autodoc sorts packages alphabetically.
40ants-doc:*symbols-with-ignored-missing-locations*variable to ignore warnings on missing source location.
This might be useful for autogenerated methods. For example, Mito does generate such reader methods here.
Support for variables was added to autodoc subsystem.
Autodoc subsystem was added. It provides a
40ants-doc/autodoc:defautodocmacro which can build an
APIreference for a given
Now we output a list of dependencies for an
Script on the search page was fixed.
Large refactoring was introduced. All files related to the documentation builder were moved to
./full/folder and corresponding packages was renamed to have
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
Fixed a few issues with
ASDFand 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!
Fixed 40ants-doc asdf system dependency from the 40ants-doc/ignored-words. Because this module should be in the core system.
Now you can refer internal documentation section of other libraries. To do this, put the link to this library documentation to the
40ants-doc:defsectionmacro and then mention other section like this:
40ants-doc-full/commondoc/mapper:map-nodesgeneric-function supports any node type which defines a method for generic-function
Default theme was fixed to work with latest Spinneret, which now escapes single quotes inside
Automatic symbol extraction now ignores dates like 2021-12-31. Now to make it work, the symbol should contain at least one alpha character.
Fixed the issue, when we tried to find uppercased xrefs inside inline code and links.
defsectionmacro. 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-packageto suppress warning on symbols which are exported but not documented.
Fixed the way of how a
TOCis built. Previosly it incorrectly shown nested
defsectionmacro now supports
Blockquotes markup is supported now.
Now external references are rendered as code and downcased according to the settings.
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.
Included changelog.lisp into the
Fixed locatives parsing in case if there are more than one
40ANTS-DOC/COMMONDOC/XREF:XREFin the text.
Now default theme removes underline from images nested into the
Fixed images collection for case when current directory is different from the
Fixed reference index generation and comparison of usual references with references where locative is a string.
EXTERNAL-DOCSargument. Together with
references.jsonfile is rendered, and you can provide a list of urls of external libraries' documentation to have an automatic cross-referencing between them.
Markdown files now will have a footer saying that a file was generated by
RSSfeed is generated for changelog. Also, changelog items can have a date now.
*DOCUMENT-NORMALIZE-PACKAGES*variable was replaced with
Now images are copied to target folder together with
HTMLdocumentation 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 Themesection.
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
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:includelocative now does not support
:FOOTERand some other arguments. Use
Added code highlighting using Highlight.js library.
Added search form which uses index in browser.
JScode was taken from Sphinx documentation builder.
Elisp code for transcriptions was fixed and now should word not only with
SLIME, but also with
40ants-doc:defsectionmacro now does not generate export code if
UPDATE-ASDF-SYSTEM-READMEwere replaced with
40ants-doc-full/builder:update-asdf-system-docs, which also supports ChangeLog.md generation. Use
40ants-doc/changelog:defchangelogto define versions.
*DOCUMENT-MAX-TABLE-OF-CONTENTS-LEVEL*were removed. Probably we'll return this feature back in other form, to restrict
Links to the GitHub now are generated automatically, if
40ants-doc-full/builder:update-asdf-system-docsfunction is used and system definition has a
*DOCUMENT-MIN-LINK-HASH-LENGTH*was removed. Use
DOWNCASE-UPPERCASE-CODEargument instead of
*DOCUMENT-DOWNCASE-UPPERCASE-CODE*. This argument is true by default.
Added warnings on symbols, referenced like internals, using
40ants-doc:defsection-copymacro to define copy of the section but with a different name.
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
Function update-asdf-system-readmes was renamed to update-asdf-system-readmes and now it generates only one
Tests were rewritten to use Rove and to support
UIOP:DEFINE-PACKAGEcan 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.