Skip to content

How to generate stdlib documentation? #1221

@sin-ack

Description

@sin-ack

I'm trying to use pkl-doc to generate documentation from a local branch I have of pkl, but when trying to point pkl-doc at stdlib/, I get:

 » pkl-doc/build/executable/pkldoc-linux-amd64 stdlib/*.pkl --output-dir stdlib-docs
–– Pkl Error ––
External members can only be defined by standard library modules.

175 | external function run(): BenchmarkResult
      ^^^^^^^^
at pkl.Benchmark#Microbenchmark (file:///home/agni/repos/third-party/pkl/stdlib/Benchmark.pkl, line 175)

How can I generate a local copy of the stdlib docs? DEVELOPMENT.adoc doesn't mention it either.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions