Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate documentation for stubs #663

Closed
21 tasks done
lars-reimann opened this issue Oct 22, 2023 · 1 comment · Fixed by #963
Closed
21 tasks done

Generate documentation for stubs #663

lars-reimann opened this issue Oct 22, 2023 · 1 comment · Fixed by #963
Assignees
@lars-reimann
Labels
documentation 📖 Improvements or additions to documentation released Included in a release
Milestone
v0.9.0

Comments

@lars-reimann
Copy link
Member

lars-reimann commented Oct 22, 2023 •
edited
Loading

Is your feature request related to a problem?

We don't have a way to generate documentation for stubs.

Desired solution

The CLI should be extended with a tool that takes a path to a directory containing stubs and outputs Markdown documentation for it. Ideally, it should integrate with Material for Mkdocs, so our DSL documentation is consistent with the one for the Python library.

  • Test system
  • Summary
  • Annotation
  • Class
  • Abstract class
  • Enum
  • Enum variant
  • Function
  • Pipeline
  • Schema
  • Segment
  • Internal segment
  • Attributes
  • Parameters
  • Results
  • TypeParameters
  • Link declarations together (types)
  • Link declarations together (parent classes)
  • Add source code
  • Experimental
  • Deprecated

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response
@lars-reimann lars-reimann added this to DSL Oct 22, 2023
@github-project-automation github-project-automation bot moved this to Backlog in DSL Oct 22, 2023
@lars-reimann lars-reimann added this to the v0.10.0 milestone Jan 8, 2024
@lars-reimann lars-reimann self-assigned this Feb 1, 2024
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Feb 12, 2024
@lars-reimann lars-reimann modified the milestones: v0.10.0, v0.9.0 Feb 18, 2024
@lars-reimann lars-reimann moved this from Backlog to Todo in DSL Feb 27, 2024
@lars-reimann lars-reimann moved this from Todo to In Progress in DSL Mar 31, 2024
@lars-reimann lars-reimann mentioned this issue Apr 1, 2024
Merged
@lars-reimann lars-reimann linked a pull request Apr 1, 2024 that will close this issue
feat: Markdown documentation generator #963
Merged
lars-reimann added a commit that referenced this issue Apr 1, 2024
@lars-reimann @megalinter-bot
feat: Markdown documentation generator (#963)
77d04de 
Closes #663

### Summary of Changes

* Add a service to generate Markdown documentation for Safe-DS files
* Add the `document` CLI command to invoke this generator
* Create Markdown documentation for the builtin stubs

---------

Co-authored-by: megalinter-bot <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress to ✔️ Done in DSL Apr 1, 2024
lars-reimann pushed a commit that referenced this issue Apr 1, 2024
@semantic-release-bot
chore(release): 0.9.0 [skip ci]
8c32794 
## [0.9.0](v0.8.0...v0.9.0) (2024-04-01)

### Features

* `unknown` default value of stub parameters ([#952](#952)) ([78103e3](78103e3)), closes [#951](#951)
* `unknown` type ([#973](#973)) ([4638249](4638249)), closes [#967](#967)
* add constraints to stubs ([#953](#953)) ([dc5bf3b](dc5bf3b))
* allow any widening/narrowing type cast ([#948](#948)) ([ce01628](ce01628))
* checking of parameter bounds ([#925](#925)) ([610604f](610604f)), closes [#18](#18)
* Markdown documentation generator ([#963](#963)) ([77d04de](77d04de)), closes [#663](#663)
* stubs for `safe-ds` library ([#950](#950)) ([155b1c0](155b1c0)), closes [#926](#926)
* VS Code command to dump diagnostics into a JSON file ([#928](#928)) ([34fa884](34fa884)), closes [#927](#927)

### Bug Fixes

* do not memoize calls containing lambdas calling segments ([#944](#944)) ([114fee6](114fee6))
* language server crash on startup ([#947](#947)) ([9923074](9923074)), closes [#945](#945)
* type checking of two union types ([#949](#949)) ([21fc485](21fc485))
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lars-reimann lars-reimann

Labels
documentation 📖 Improvements or additions to documentation released Included in a release
Projects
DSL
Archived in project
Milestone
v0.9.0
Development

Successfully merging a pull request may close this issue.

feat: Markdown documentation generator Safe-DS/DSL
1 participant
@lars-reimann