Liking cljdoc? Tell your friends :D

grimoire.api

This namespace serves to implement an abstraction layer for looking up examples, symbols, namespaces and artifacts as values without regard to the implementation of the datastore. Ports of Grimoire to different datastores should only need to extend the multimethods in this namespace.

API Contract assumptions:

  • Everything has metadata, even if it's nil. If metadata for a Thing cannot be found, then the Thing itself is not in the datastore.
This namespace serves to implement an abstraction layer for looking up
examples, symbols, namespaces and artifacts as values without regard to the
implementation of the datastore. Ports of Grimoire to different datastores
should only need to extend the multimethods in this namespace.

API Contract assumptions:

- Everything has metadata, even if it's nil. If metadata for a Thing cannot
  be found, then the Thing itself is not in the datastore.
raw docstring

grimoire.api.fs.impl

Filesystem datastore implementation details. This namespace is not part of the intentional API exposed in grimoire.api and should not be used by library client code.

Filesystem datastore implementation details. This namespace is not part of
the intentional API exposed in `grimoire.api` and should not be used by
library client code.
raw docstring

grimoire.api.fs.read

Filesystem datastore implementation of the Grimoire API.

Filesystem datastore implementation of the Grimoire API.
raw docstring

No vars found in this namespace.

grimoire.api.fs.write

Filesystem datastore implementation of the Grimoire API.

Filesystem datastore implementation of the Grimoire API.
raw docstring

No vars found in this namespace.

grimoire.api.web.read

This namespace implements the reading and listing parts of the Grimoire API using the Grimoire webservice as its backend.

Writing to this datastore is not supported yet™. list-classes is not supported yet™. list-defs lists all defs, not just defs of a type.

To use this backend, you will need to load this namespace, and then invoke the API with a configuration as constructed by grimoire.web/->Config.

Note that the host need not be conj.io, but must host a Grimoire 0.4 or later instance providing the v2 API. The host string should include a http or https protocol specifier as appropriate and should not end in a /.

This namespace implements the reading and listing parts of the Grimoire API
using the Grimoire webservice as its backend.

Writing to this datastore is not supported yet™.
`list-classes` is not supported yet™.
`list-defs` lists all defs, not just defs of a type.

To use this backend, you will need to load this namespace, and then invoke the
API with a configuration as constructed by `grimoire.web/->Config`.

Note that the host need not be conj.io, but must host a Grimoire 0.4 or later
instance providing the v2 API. The host string should include a http or https
protocol specifier as appropriate and should not end in a /.
raw docstring

grimoire.either

Quick and dirty implementation of something like Haskell's Either[Success, Failure] for Clojure. Not the nicest thing in the world, but it'll do the job. Used to indicate success and failure throughout the lib-grimoire API.

Quick and dirty implementation of something like Haskell's Either[Success,
Failure] for Clojure. Not the nicest thing in the world, but it'll do the
job. Used to indicate success and failure throughout the lib-grimoire API.
raw docstring

grimoire.things

This namespace implements a "thing" structure, approximating a URI, for uniquely naming and referencing entities in a Grimoire documentation store.

Thing ::= Sum[Group, Artifact, Version, Platform, Namespace, Def, Note, Example]; Group ::= Record[ Name: String]; Artifact ::= Record[Parent: Group, Name: String]; Version ::= Record[Parent: Artifact, Name: String]; Platform ::= Record[Parent: Version, Name: String]; Namespace ::= Record[Parent: Platform, Name: String]; Def ::= Record[Parent: Namespace, Name: String];

Note ::= Record[Parent: Thing, Handle: String]; Example ::= Record[Parent: Thing, Handle: String];

This namespace implements a "thing" structure, approximating a URI, for
uniquely naming and referencing entities in a Grimoire documentation
store.

Thing     ::= Sum[Group, Artifact, Version, Platform,
                  Namespace, Def, Note, Example];
Group     ::= Record[                   Name: String];
Artifact  ::= Record[Parent: Group,     Name: String];
Version   ::= Record[Parent: Artifact,  Name: String];
Platform  ::= Record[Parent: Version,   Name: String];
Namespace ::= Record[Parent: Platform,  Name: String];
Def       ::= Record[Parent: Namespace, Name: String];

Note      ::= Record[Parent: Thing,     Handle: String];
Example   ::= Record[Parent: Thing,     Handle: String];
raw docstring

grimoire.util

A namespace of stupid little helper bits including the Grimoire munge operations.

A namespace of stupid little helper bits including the Grimoire munge operations.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close