WIP: Generate documentation of a library

JaroslavTulach commented 3 months ago

Pull Request Description

Generate documentation of a library into its docs/api directory.

Important Notes

Use following command:

sbt:enso> runEngineDistribution --docs --in-project ./built-distribution/enso-engine-0.0.0-dev-linux-amd64/enso-0.0.0-dev/lib/Standard/Base/0.0.0-dev/

to generate documentation for Standard.Base.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

[x] The documentation has been updated, obviously, that's the whole point of this PR ;-)
[ ] All code follows the Scala, Java,
[ ] Make the generation of documentation for Standard libraries part of CI

JaroslavTulach commented 3 months ago

I believe this PR provides good enough infrastructure for generating the documentation for a library. Use:

sbt:enso> runEngineDistribution --docs --in-project ./built-distribution/enso-engine-0.0.0-dev-linux-amd64/enso-0.0.0-dev/lib/Standard/Base/0.0.0-dev/

Please pick the PR up and cultivate the content of .md files! CCing @jdunkerley, @Akirathan

enso-bot[bot] commented 3 months ago

Jaroslav Tulach reports a new STANDUP for yesterday (2024-06-15):

Progress: - infrastructure to generate documentation: https://github.com/enso-org/enso/pull/10291

negative review of removeContextLock: https://github.com/enso-org/enso/pull/10273#pullrequestreview-2120031625 It should be finished by 2024-06-21.

enso-org / enso