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.

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

Adding basic doc generation functionality #60

Closed
wants to merge 1 commit into from
Closed

Adding basic doc generation functionality #60

wants to merge 1 commit into from

Conversation

TWSiO
Copy link

@TWSiO TWSiO commented Jan 24, 2024

Description

This change adds basic documentation generation functionality to nupm.

Using the current package's code, or paths to other modules it will generate a directory of markdown files based on the internal metadata about the modules and commands (data from scope).

The majority of the code is shamelessly stolen from @amtoine's nu-git-manager toolkit script and modified.

There's a lot of basic functionality missing that I'd like to add like generating HTML and documenting plugins, but this is a good first step.

I also added the generated documentation for nupm itself because it seemed appropriate.

@kubouch
Copy link
Contributor

kubouch commented Jan 25, 2024

Before adding nupm doc and committing to this particular style, we should first have a discussion about how a doc autogeneration would work in Nushell in general. Then add support for it in nupm. So far, we haven't discussed this thoroughly in the core team. I'm not saying this is a bad doc style, and we might as well use it as a starting point for the discussion, but I don't feel comfortable committing it to nupm yet because it might as well change significantly (e.g., we could add this functionality to Nushell itself, or use a separate program to do the doc autogeneration). One approach would be to create a nupm experimental subcommand group and move the doc there without commitment, just to test it out.

@amtoine
Copy link
Member

amtoine commented Jan 25, 2024

marking as DRAFT for now

@amtoine amtoine marked this pull request as draft January 25, 2024 18:09
@TWSiO TWSiO closed this by deleting the head repository Apr 9, 2024
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.

3 participants