How to generate stdlib documentation?
- Dominant language
- Java
- Stars
- 11.5k
- Forks
- 402
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 20
Description
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.
Contributor guide
Research direction
Start with the pkl-doc/build/executable/pkldoc-linux-amd64 command and the stdlib/ input that produces the reported external-members error. Check DEVELOPMENT.adoc for the missing workflow, then document the verified way to generate a local copy of the stdlib docs and confirm it works.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100