Skip to content

NDSL Documentation via MkDocs#205

Merged
romanc merged 7 commits into
developfrom
feature/ndsl_documentation
Aug 21, 2025
Merged

NDSL Documentation via MkDocs#205
romanc merged 7 commits into
developfrom
feature/ndsl_documentation

Conversation

@gmao-ckung
Copy link
Copy Markdown
Collaborator

Description
This branch contains files to generate documentation based on the docstrings within NDSL files through the use of MkDocs.

@gmao-ckung gmao-ckung requested a review from romanc August 19, 2025 15:13
Copy link
Copy Markdown
Collaborator

@romanc romanc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for setting this up, Chris. I think this is good as a first version. Basically, this just adds everything we have. We might want to reconsider what to show. I'd be nice, if we could steer users towards functions they should use (e.g. public API) and away from implementation details deep down in modules.

I've added two commit as review:

  1. optional dependencies moved to pyproject.toml with PR #159
  2. I locally checkout the branch and when running the local server, I fixed a couple warnings that were easy to fix. The console is now flooded with missing argument types (which is a good thing, we want to get them out of the way eventually anyway), so it's hard to miss things.

As said above, we should probably have a conversion if we want to have modules starting with _ (usually means they are "private" and not part of the public API) in the docs at all. Let's merge this first and have the discussion afterwards. We anyway don't (auto-) publish docs yet, so imo it's safe to merge increments.

@gmao-ckung
Copy link
Copy Markdown
Collaborator Author

Yes, I do think we should definitely take another look at which docstrings to expose with the documentation.

@gmao-ckung gmao-ckung added this pull request to the merge queue Aug 21, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 21, 2025
@romanc romanc added this pull request to the merge queue Aug 21, 2025
Merged via the queue into develop with commit 8297cc9 Aug 21, 2025
5 checks passed
@gmao-ckung gmao-ckung deleted the feature/ndsl_documentation branch August 21, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants