The docs-builder Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The docs-builder Reference Manual

This is the docs-builder Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:39:14 2022 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Common Lisp Docs Builder

DOCS-BUILDER ASDF System Details

This system is a generic documentation builder for Common Lisp Systems. It able to generate HTML documentation for specified ASDF system.

The idea is to use docs-builder as an universal HTML documentation builders which can be used in a continuous integration pipeline. For example, it is used inside build-docs GitHub action, which can be used to build docs update gh-pages for any Common Lisp library (if it is uses documentation generator supported by docs-builder).

Currently Docs Builder supports only 40ants-doc, MGL-PAX and Geneva, but it can be extended to support other documentation builders, covered by examples in here: cl-doc-systems.github.io.

Usage

Documentation can be built in a few ways: from the lisp REPL, command-line and using the GitHub action.

REPL

From the REPL, you need first to call a docs-builder:build function:

function docs-builder:build system &rest rest &key (error-on-warnings t) &allow-other-keys

Builds HTML documentation for ASDF system and returns absolute path to the dir with docs.

Inside, it will try to guess which documentation builder should be used:

generic-function docs-builder/guesser:guess-builder system

Returns a builder object which can be passed to the docs-builder/builder:build generic-function along with system.

The builder type is guessed using different euristics which depends on a documentation system.

If you want to add support for a new documentation generator, use defguesser macro.

Then it will pass the builder object and ASDF system to the docs-builder/builder:build generic-function:

generic-function docs-builder/builder:build builder system &key local root-sections &allow-other-keys

Builds HTML documentation for ASDF system and returns absolute path to the dir with docs.

Here is an example how to build documentation for :docs-builder ASDF system:

CL-USER> (docs-builder:build :docs-builder)
 <INFO> [02:12:00] docs-builder/core core.lisp (build :before system) -
  Building docs for system #<PACKAGE-INFERRED-SYSTEM "docs-builder"> found at /Users/art/projects/docs-builder/
 <INFO> [02:12:00] docs-builder/builders/mgl-pax/builder builder.lisp (build builder system) -
  Building docs in "/Users/art/projects/docs-builder/docs/build/" dir
#P"/Users/art/projects/docs-builder/docs/build/"

Command-line

You can use builder from command-line. To do this, first install it using Roswell:

# Note, we need to install this patched mgl-pax
# first, to be able to load docs-builder.
# This step in necessary until this pull
# will be merged:
# https://github.com/melisgl/mgl-pax/pull/8

$ ros install 40ants/doc

$ ros install 40ants/docs-builder

Here we call it to build documentation for "docs-builder" ASDF system:

$ build-docs docs-builder
 <INFO> [02:26:32] docs-builder/main main.lisp (main) -
  Quickloading system "docs-builder"
 <INFO> [02:26:34] docs-builder/core core.lisp (build :before system) -
  Building docs for system #<PACKAGE-INFERRED-SYSTEM "docs-builder"> found at /Users/art/projects/docs-builder/
 <INFO> [02:26:34] docs-builder/builders/mgl-pax/builder builder.lisp (build builder system) -
  Building docs in "/Users/art/projects/docs-builder/docs/build/" dir
Scan was called 2146 times.

GitHub Action

If you host your project on the GitHub, then the most easy way to build and host documentation would be to use Github Pages.

To build docs and update the site, create a file .github/workflows/docs.yml with a content like this:

name: 'Docs'

on:
  # This will run tests on pushes
  # to master branch and every monday:
  push:
    branches:
      - 'main'
      - 'master'
  schedule:
    - cron:  '0 10 * * 1'

jobs:
  build-docs:
    runs-on: ubuntu-latest
    
    env:
      LISP: sbcl-bin

    steps:
      - uses: actions/checkout@v1
      - uses: 40ants/setup-lisp@v1
      - uses: 40ants/build-docs@v1
        with:
          asdf-system: cl-info

You'll find more info in the action's documentation.

Additional Params

You can customize a builder by defining a method for this generic function:

generic-function docs-config:docs-config asdf-system

Should return a plist which will be passed as keyword arguments to the documentation builder when building docs for a given asdf-system.

Implement a method, EQL specialized on a concrete ASDF system.

Here is a typical method I use for my own libraries to set a custom theme for 40ants-doc system:

(defmethod docs-config ((system (eql (asdf:find-system "cl-info"))))
  ;; 40ANTS-DOC-THEME-40ANTS system will bring
  ;; as dependency a full 40ANTS-DOC but we don't want
  ;; unnecessary dependencies here:
  (uiop:symbol-call :ql :quickload :40ants-doc-theme-40ants)
  (list :theme
        (find-symbol "40ANTS-THEME"
                     (find-package "40ANTS-DOC-THEME-40ANTS"))))

Try to load additional dependencies inside the method. This users of your library will not download dependencies needed only for building documentation.

For some special cases it might be useful to return a special key DYNAMIC-BINDINGS. This could be useful, for configuring some custom extensions like it did with interactive demos for the Weblocks. Here is how a method looks like when I configure Weblocks documentation builder:

(defmethod docs-config ((system (eql (asdf:find-system "weblocks"))))
  ;; ...
  (list :theme
        (find-symbol "40ANTS-THEME"
                     (find-package "40ANTS-DOC-THEME-40ANTS"))
        :dynamic-bindings (list (cons 'weblocks/doc/example:*server-url*
                                      ;; When local examples server is running,
                                      ;; we'll be using it instead of production:
                                      (unless weblocks/doc/example::*port*
                                        "http://examples.40ants.com/"))))

Roadmap


[generated by 40ANTS-DOC]

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 docs-builder

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Description

A meta documentation builder for Common Lisp projects.

Dependencies
Source

docs-builder.asd (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.2 docs-builder/builders/40ants-doc/guesser

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.3 docs-builder/docs

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.4 docs-builder/builders/mgl-pax/guesser

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.5 docs-builder/builders/geneva/guesser

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.6 docs-builder/utils

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependency

40ants-doc

Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.7 docs-builder/core

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.8 docs-builder/builder

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependencies
Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.9 docs-config

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder/

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Description

A protocol for defining configuration for DOCS-BUILDER system.

Dependency

docs-config/config (system)

Source

docs-config.asd (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.10 docs-config/config

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder/

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Source

docs-config.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Systems   [Contents][Index]

2.11 docs-builder/guesser

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Previous: , Up: Systems   [Contents][Index]

2.12 docs-builder/changelog

Author

Alexander Artemenko

Home Page

https://40ants.com/docs-builder

Source Control

(:git "https://github.com/40ants/docs-builder")

Bug Tracker

https://github.com/40ants/docs-builder/issues

License

Unlicense

Dependency

40ants-doc/changelog

Source

docs-builder.asd (file)

Component

file-type.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 docs-config.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/docs-builder-20211209-git/docs-config.asd

Systems

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 docs-builder.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/docs-builder-20211209-git/docs-builder.asd

Systems

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 docs-builder/builders/40ants-doc/guesser/file-type.lisp

Parent

docs-builder/builders/40ants-doc/guesser (system)

Location

builders/40ants-doc/guesser.lisp

Packages

docs-builder/builders/40ants-doc/guesser

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 docs-builder/docs/file-type.lisp

Parent

docs-builder/docs (system)

Location

docs.lisp

Packages

docs-builder/docs

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 docs-builder/builders/mgl-pax/guesser/file-type.lisp

Parent

docs-builder/builders/mgl-pax/guesser (system)

Location

builders/mgl-pax/guesser.lisp

Packages

docs-builder/builders/mgl-pax/guesser

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 docs-builder/builders/geneva/guesser/file-type.lisp

Parent

docs-builder/builders/geneva/guesser (system)

Location

builders/geneva/guesser.lisp

Packages

docs-builder/builders/geneva/guesser

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 docs-builder/utils/file-type.lisp

Parent

docs-builder/utils (system)

Location

utils.lisp

Packages

docs-builder/utils

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 docs-builder/core/file-type.lisp

Parent

docs-builder/core (system)

Location

core.lisp

Packages

docs-builder

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 docs-builder/builder/file-type.lisp

Parent

docs-builder/builder (system)

Location

builder.lisp

Packages

docs-builder/builder

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 docs-config/config/file-type.lisp

Parent

docs-config/config (system)

Location

config.lisp

Packages

docs-config

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 docs-builder/guesser/file-type.lisp

Parent

docs-builder/guesser (system)

Location

guesser.lisp

Packages

docs-builder/guesser

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.12 docs-builder/changelog/file-type.lisp

Parent

docs-builder/changelog (system)

Location

changelog.lisp

Packages

docs-builder/changelog

Exported Definitions

@changelog (special variable)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 docs-builder/builders/40ants-doc/guesser

Source

file-type.lisp (file)

Use List

common-lisp

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 docs-builder/docs

Source

file-type.lisp (file)

Use List

common-lisp

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.3 docs-builder/builders/mgl-pax/guesser

Source

file-type.lisp (file)

Use List

common-lisp

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.4 docs-builder/builders/geneva/guesser

Source

file-type.lisp (file)

Use List

common-lisp

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.5 docs-builder/utils

The utils for documentation builders.

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.6 docs-builder

Source

file-type.lisp (file)

Nickname

docs-builder/core

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.7 docs-builder/builder

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.8 docs-config

Source

file-type.lisp (file)

Nickname

docs-config/config

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.9 docs-builder/guesser

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.10 docs-builder/changelog

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

@changelog (special variable)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: @changelog
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: @index
Package

docs-builder

Source

file-type.lisp (file)

Special Variable: @readme
Package

docs-builder

Source

file-type.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: defguesser NAME (SYSTEM) &body BODY
Package

docs-builder/guesser

Source

file-type.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: build SYSTEM &rest REST &key ERROR-ON-WARNINGS &allow-other-keys

Builds HTML documentation for ASDF system and returns absolute path to the dir with docs.

Package

docs-builder

Source

file-type.lisp (file)

Function: external-dependencies SYSTEM &key ALL

Returns a list of string with names of external dependencies of the system.

It works with package-inferred systems too, recursively collecting external-dependencies of all subsystems.

Warning! By default, this function does not return dependencies of dependencies. To get them all, add :ALL T option.

Package

docs-builder/utils

Source

file-type.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: build BUILDER SYSTEM &key &allow-other-keys

Builds HTML documentation for ASDF system and returns absolute path to the dir with docs.

Package

docs-builder/builder

Source

file-type.lisp (file)

Methods
Method: build BUILDER (SYSTEM system) &rest REST &key &allow-other-keys around
Method: build BUILDER (SYSTEM symbol) &rest REST &key &allow-other-keys
Method: build BUILDER (SYSTEM string) &rest REST &key &allow-other-keys
Generic Function: docs-config ASDF-SYSTEM

Should return a plist which will be passed as keyword
arguments to the documentation builder when building
docs for a given asdf-system.

Implement a method, EQL specialized on a concrete ASDF system.

Here is a typical method I use for my own libraries to set
a custom theme for 40ANTS-DOC system:

“‘lisp
(defmethod docs-config ((system (eql (asdf:find-system "cl-info"))))
;; 40ANTS-DOC-THEME-40ANTS system will bring
;; as dependency a full 40ANTS-DOC but we don’t want
;; unnecessary dependencies here:
(uiop:symbol-call :ql :quickload :40ants-doc-theme-40ants)
(list :theme
(find-symbol "40ANTS-THEME"
(find-package "40ANTS-DOC-THEME-40ANTS")))) “‘

Try to load additional dependencies inside the method. This users of your library will not download dependencies needed only for building documentation.

For some special cases it might be useful to return a special key DYNAMIC-BINDINGS. This could be useful, for configuring some custom extensions like it did with interactive demos for the [Weblocks](https://40ants.com/weblocks/). Here is how a method looks like when I configure Weblocks documentation builder:

“‘
(defmethod docs-config ((system (eql (asdf:find-system "weblocks"))))
;; ...
(list :theme
(find-symbol "40ANTS-THEME"
(find-package "40ANTS-DOC-THEME-40ANTS")) :dynamic-bindings (list (cons ’weblocks/doc/example:*server-url*
;; When local examples server is running, ;; we’ll be using it instead of production: (unless weblocks/doc/example::*port* "http://examples.40ants.com/")))) “‘

Package

docs-config

Source

file-type.lisp (file)

Methods
Method: docs-config (SYSTEM (eql docs-builder))
Source

file-type.lisp (file)

Method: docs-config SYSTEM
Method: docs-config (SYSTEM-NAME symbol)
Method: docs-config (SYSTEM-NAME string)
Generic Function: guess-builder SYSTEM

Returns a builder object which can be passed to the DOCS-BUILDER/BUILDER:BUILD generic-function along with system.

The builder type is guessed using different euristics which depends on a documentation system.

If you want to add support for a new documentation generator, use DEFGUESSER macro.

Package

docs-builder/guesser

Source

file-type.lisp (file)

Methods
Method: guess-builder (SYSTEM system)
Method: guess-builder (SYSTEM string)
Method: guess-builder (SYSTEM symbol)
Generic Function: num-of-warnings CONDITION
Package

docs-builder

Methods
Method: num-of-warnings (CONDITION documentation-has-problems)
Source

file-type.lisp (file)

Generic Function: system-packages SYSTEM

Returns a list of packages created by ASDF system.

Default implementation returns a package having the same name as a system and all packages matched to package-inferred subsystems:

“‘
CL-USER> (docs-builder/utils:system-packages :docs-builder) (#<PACKAGE "DOCS-BUILDER">
#<PACKAGE "DOCS-BUILDER/UTILS">
#<PACKAGE "DOCS-BUILDER/GUESSER">
#<PACKAGE "DOCS-BUILDER/BUILDERS/GENEVA/GUESSER">
#<PACKAGE "DOCS-BUILDER/BUILDER">
#<PACKAGE "DOCS-BUILDER/BUILDERS/MGL-PAX/GUESSER">
#<PACKAGE "DOCS-BUILDER/DOCS">
#<PACKAGE "DOCS-BUILDER/BUILDERS/MGL-PAX/BUILDER">)
“‘

This function can be used by builder to find pieces of documentation. For example, DOCS-BUILDER/BUILDERS/MGL-PAX/GUESSER:@INDEX
builder uses it to find documentation sections.

Package

docs-builder/utils

Source

file-type.lisp (file)

Methods
Method: system-packages (SYSTEM string)
Method: system-packages (SYSTEM symbol)
Method: system-packages (SYSTEM system)

Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: documentation-has-problems ()
Package

docs-builder

Source

file-type.lisp (file)

Direct superclasses

error (condition)

Direct methods

num-of-warnings (method)

Direct slots
Slot: num-of-warnings
Initargs

:num-of-warnings

Readers

num-of-warnings (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *badges*
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: *guessers*
Package

docs-builder/guesser

Source

file-type.lisp (file)

Special Variable: *ignore-words*
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: *introduction*
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: *system-to-builder*
Package

docs-builder/guesser

Source

file-type.lisp (file)

Special Variable: 0.1.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.2.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.3.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.4.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.4.1
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.4.2
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.5.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.5.1
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.5.2
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.5.3
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.6.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.6.1
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.6.2
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.7.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.7.1
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.8.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: 0.9.0
Package

docs-builder/changelog

Source

file-type.lisp (file)

Special Variable: @adding-a-build-method
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @adding-a-builder-class
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @adding-a-guesser
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @additional-params
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @api
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @command-line-usage
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @extending
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @github-action-usage
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @index
Package

docs-builder/builders/40ants-doc/guesser

Source

file-type.lisp (file)

Special Variable: @index
Package

docs-builder/builders/mgl-pax/guesser

Source

file-type.lisp (file)

Special Variable: @index
Package

docs-builder/builders/geneva/guesser

Source

file-type.lisp (file)

Special Variable: @repl-usage
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @roadmap
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @supported-builders
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @todo
Package

docs-builder/builders/40ants-doc/guesser

Source

file-type.lisp (file)

Special Variable: @todo
Package

docs-builder/builders/geneva/guesser

Source

file-type.lisp (file)

Special Variable: @usage
Package

docs-builder/docs

Source

file-type.lisp (file)

Special Variable: @utils
Package

docs-builder/utils

Source

file-type.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: 40ants-doc SYSTEM
Package

docs-builder/builders/40ants-doc/guesser

Source

file-type.lisp (file)

Function: ensure-supported ITEM

Returns either a string or nil if this item should be skipped.

ITEM can be a string or a list like:

(:feature :windows "winhttp")

Package

docs-builder/utils

Source

file-type.lisp (file)

Function: geneva SYSTEM
Package

docs-builder/builders/geneva/guesser

Source

file-type.lisp (file)

Function: mgl-pax SYSTEM
Package

docs-builder/builders/mgl-pax/guesser

Source

file-type.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
docs-builder.asd: The docs-builder․asd file
docs-builder/builder/file-type.lisp: The docs-builder/builder/file-type․lisp file
docs-builder/builders/40ants-doc/guesser/file-type.lisp: The docs-builder/builders/40ants-doc/guesser/file-type․lisp file
docs-builder/builders/geneva/guesser/file-type.lisp: The docs-builder/builders/geneva/guesser/file-type․lisp file
docs-builder/builders/mgl-pax/guesser/file-type.lisp: The docs-builder/builders/mgl-pax/guesser/file-type․lisp file
docs-builder/changelog/file-type.lisp: The docs-builder/changelog/file-type․lisp file
docs-builder/core/file-type.lisp: The docs-builder/core/file-type․lisp file
docs-builder/docs/file-type.lisp: The docs-builder/docs/file-type․lisp file
docs-builder/guesser/file-type.lisp: The docs-builder/guesser/file-type․lisp file
docs-builder/utils/file-type.lisp: The docs-builder/utils/file-type․lisp file
docs-config.asd: The docs-config․asd file
docs-config/config/file-type.lisp: The docs-config/config/file-type․lisp file

F
File, Lisp, docs-builder.asd: The docs-builder․asd file
File, Lisp, docs-builder/builder/file-type.lisp: The docs-builder/builder/file-type․lisp file
File, Lisp, docs-builder/builders/40ants-doc/guesser/file-type.lisp: The docs-builder/builders/40ants-doc/guesser/file-type․lisp file
File, Lisp, docs-builder/builders/geneva/guesser/file-type.lisp: The docs-builder/builders/geneva/guesser/file-type․lisp file
File, Lisp, docs-builder/builders/mgl-pax/guesser/file-type.lisp: The docs-builder/builders/mgl-pax/guesser/file-type․lisp file
File, Lisp, docs-builder/changelog/file-type.lisp: The docs-builder/changelog/file-type․lisp file
File, Lisp, docs-builder/core/file-type.lisp: The docs-builder/core/file-type․lisp file
File, Lisp, docs-builder/docs/file-type.lisp: The docs-builder/docs/file-type․lisp file
File, Lisp, docs-builder/guesser/file-type.lisp: The docs-builder/guesser/file-type․lisp file
File, Lisp, docs-builder/utils/file-type.lisp: The docs-builder/utils/file-type․lisp file
File, Lisp, docs-config.asd: The docs-config․asd file
File, Lisp, docs-config/config/file-type.lisp: The docs-config/config/file-type․lisp file

L
Lisp File, docs-builder.asd: The docs-builder․asd file
Lisp File, docs-builder/builder/file-type.lisp: The docs-builder/builder/file-type․lisp file
Lisp File, docs-builder/builders/40ants-doc/guesser/file-type.lisp: The docs-builder/builders/40ants-doc/guesser/file-type․lisp file
Lisp File, docs-builder/builders/geneva/guesser/file-type.lisp: The docs-builder/builders/geneva/guesser/file-type․lisp file
Lisp File, docs-builder/builders/mgl-pax/guesser/file-type.lisp: The docs-builder/builders/mgl-pax/guesser/file-type․lisp file
Lisp File, docs-builder/changelog/file-type.lisp: The docs-builder/changelog/file-type․lisp file
Lisp File, docs-builder/core/file-type.lisp: The docs-builder/core/file-type․lisp file
Lisp File, docs-builder/docs/file-type.lisp: The docs-builder/docs/file-type․lisp file
Lisp File, docs-builder/guesser/file-type.lisp: The docs-builder/guesser/file-type․lisp file
Lisp File, docs-builder/utils/file-type.lisp: The docs-builder/utils/file-type․lisp file
Lisp File, docs-config.asd: The docs-config․asd file
Lisp File, docs-config/config/file-type.lisp: The docs-config/config/file-type․lisp file

Jump to:   D   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   4  
B   D   E   F   G   M   N   S  
Index Entry  Section

4
40ants-doc: Internal functions

B
build: Exported functions
build: Exported generic functions
build: Exported generic functions
build: Exported generic functions
build: Exported generic functions

D
defguesser: Exported macros
docs-config: Exported generic functions
docs-config: Exported generic functions
docs-config: Exported generic functions
docs-config: Exported generic functions
docs-config: Exported generic functions

E
ensure-supported: Internal functions
external-dependencies: Exported functions

F
Function, 40ants-doc: Internal functions
Function, build: Exported functions
Function, ensure-supported: Internal functions
Function, external-dependencies: Exported functions
Function, geneva: Internal functions
Function, mgl-pax: Internal functions

G
Generic Function, build: Exported generic functions
Generic Function, docs-config: Exported generic functions
Generic Function, guess-builder: Exported generic functions
Generic Function, num-of-warnings: Exported generic functions
Generic Function, system-packages: Exported generic functions
geneva: Internal functions
guess-builder: Exported generic functions
guess-builder: Exported generic functions
guess-builder: Exported generic functions
guess-builder: Exported generic functions

M
Macro, defguesser: Exported macros
Method, build: Exported generic functions
Method, build: Exported generic functions
Method, build: Exported generic functions
Method, docs-config: Exported generic functions
Method, docs-config: Exported generic functions
Method, docs-config: Exported generic functions
Method, docs-config: Exported generic functions
Method, guess-builder: Exported generic functions
Method, guess-builder: Exported generic functions
Method, guess-builder: Exported generic functions
Method, num-of-warnings: Exported generic functions
Method, system-packages: Exported generic functions
Method, system-packages: Exported generic functions
Method, system-packages: Exported generic functions
mgl-pax: Internal functions

N
num-of-warnings: Exported generic functions
num-of-warnings: Exported generic functions

S
system-packages: Exported generic functions
system-packages: Exported generic functions
system-packages: Exported generic functions
system-packages: Exported generic functions

Jump to:   4  
B   D   E   F   G   M   N   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   0   @  
N   S  
Index Entry  Section

*
*badges*: Internal special variables
*guessers*: Internal special variables
*ignore-words*: Internal special variables
*introduction*: Internal special variables
*system-to-builder*: Internal special variables

0
0.1.0: Internal special variables
0.2.0: Internal special variables
0.3.0: Internal special variables
0.4.0: Internal special variables
0.4.1: Internal special variables
0.4.2: Internal special variables
0.5.0: Internal special variables
0.5.1: Internal special variables
0.5.2: Internal special variables
0.5.3: Internal special variables
0.6.0: Internal special variables
0.6.1: Internal special variables
0.6.2: Internal special variables
0.7.0: Internal special variables
0.7.1: Internal special variables
0.8.0: Internal special variables
0.9.0: Internal special variables

@
@adding-a-build-method: Internal special variables
@adding-a-builder-class: Internal special variables
@adding-a-guesser: Internal special variables
@additional-params: Internal special variables
@api: Internal special variables
@changelog: Exported special variables
@command-line-usage: Internal special variables
@extending: Internal special variables
@github-action-usage: Internal special variables
@index: Exported special variables
@index: Internal special variables
@index: Internal special variables
@index: Internal special variables
@readme: Exported special variables
@repl-usage: Internal special variables
@roadmap: Internal special variables
@supported-builders: Internal special variables
@todo: Internal special variables
@todo: Internal special variables
@usage: Internal special variables
@utils: Internal special variables

N
num-of-warnings: Exported conditions

S
Slot, num-of-warnings: Exported conditions
Special Variable, *badges*: Internal special variables
Special Variable, *guessers*: Internal special variables
Special Variable, *ignore-words*: Internal special variables
Special Variable, *introduction*: Internal special variables
Special Variable, *system-to-builder*: Internal special variables
Special Variable, 0.1.0: Internal special variables
Special Variable, 0.2.0: Internal special variables
Special Variable, 0.3.0: Internal special variables
Special Variable, 0.4.0: Internal special variables
Special Variable, 0.4.1: Internal special variables
Special Variable, 0.4.2: Internal special variables
Special Variable, 0.5.0: Internal special variables
Special Variable, 0.5.1: Internal special variables
Special Variable, 0.5.2: Internal special variables
Special Variable, 0.5.3: Internal special variables
Special Variable, 0.6.0: Internal special variables
Special Variable, 0.6.1: Internal special variables
Special Variable, 0.6.2: Internal special variables
Special Variable, 0.7.0: Internal special variables
Special Variable, 0.7.1: Internal special variables
Special Variable, 0.8.0: Internal special variables
Special Variable, 0.9.0: Internal special variables
Special Variable, @adding-a-build-method: Internal special variables
Special Variable, @adding-a-builder-class: Internal special variables
Special Variable, @adding-a-guesser: Internal special variables
Special Variable, @additional-params: Internal special variables
Special Variable, @api: Internal special variables
Special Variable, @changelog: Exported special variables
Special Variable, @command-line-usage: Internal special variables
Special Variable, @extending: Internal special variables
Special Variable, @github-action-usage: Internal special variables
Special Variable, @index: Exported special variables
Special Variable, @index: Internal special variables
Special Variable, @index: Internal special variables
Special Variable, @index: Internal special variables
Special Variable, @readme: Exported special variables
Special Variable, @repl-usage: Internal special variables
Special Variable, @roadmap: Internal special variables
Special Variable, @supported-builders: Internal special variables
Special Variable, @todo: Internal special variables
Special Variable, @todo: Internal special variables
Special Variable, @usage: Internal special variables
Special Variable, @utils: Internal special variables

Jump to:   *   0   @  
N   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   P   S  
Index Entry  Section

C
Condition, documentation-has-problems: Exported conditions

D
docs-builder: The docs-builder system
docs-builder: The docs-builder package
docs-builder/builder: The docs-builder/builder system
docs-builder/builder: The docs-builder/builder package
docs-builder/builders/40ants-doc/guesser: The docs-builder/builders/40ants-doc/guesser system
docs-builder/builders/40ants-doc/guesser: The docs-builder/builders/40ants-doc/guesser package
docs-builder/builders/geneva/guesser: The docs-builder/builders/geneva/guesser system
docs-builder/builders/geneva/guesser: The docs-builder/builders/geneva/guesser package
docs-builder/builders/mgl-pax/guesser: The docs-builder/builders/mgl-pax/guesser system
docs-builder/builders/mgl-pax/guesser: The docs-builder/builders/mgl-pax/guesser package
docs-builder/changelog: The docs-builder/changelog system
docs-builder/changelog: The docs-builder/changelog package
docs-builder/core: The docs-builder/core system
docs-builder/docs: The docs-builder/docs system
docs-builder/docs: The docs-builder/docs package
docs-builder/guesser: The docs-builder/guesser system
docs-builder/guesser: The docs-builder/guesser package
docs-builder/utils: The docs-builder/utils system
docs-builder/utils: The docs-builder/utils package
docs-config: The docs-config system
docs-config: The docs-config package
docs-config/config: The docs-config/config system
documentation-has-problems: Exported conditions

P
Package, docs-builder: The docs-builder package
Package, docs-builder/builder: The docs-builder/builder package
Package, docs-builder/builders/40ants-doc/guesser: The docs-builder/builders/40ants-doc/guesser package
Package, docs-builder/builders/geneva/guesser: The docs-builder/builders/geneva/guesser package
Package, docs-builder/builders/mgl-pax/guesser: The docs-builder/builders/mgl-pax/guesser package
Package, docs-builder/changelog: The docs-builder/changelog package
Package, docs-builder/docs: The docs-builder/docs package
Package, docs-builder/guesser: The docs-builder/guesser package
Package, docs-builder/utils: The docs-builder/utils package
Package, docs-config: The docs-config package

S
System, docs-builder: The docs-builder system
System, docs-builder/builder: The docs-builder/builder system
System, docs-builder/builders/40ants-doc/guesser: The docs-builder/builders/40ants-doc/guesser system
System, docs-builder/builders/geneva/guesser: The docs-builder/builders/geneva/guesser system
System, docs-builder/builders/mgl-pax/guesser: The docs-builder/builders/mgl-pax/guesser system
System, docs-builder/changelog: The docs-builder/changelog system
System, docs-builder/core: The docs-builder/core system
System, docs-builder/docs: The docs-builder/docs system
System, docs-builder/guesser: The docs-builder/guesser system
System, docs-builder/utils: The docs-builder/utils system
System, docs-config: The docs-config system
System, docs-config/config: The docs-config/config system

Jump to:   C   D   P   S