Skip to content

📝(api) add CLI documentation #203

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
Open
jmaupetit wants to merge 4 commits into
base: main
Choose a base branch
from
Open

📝(api) add CLI documentation #203

jmaupetit wants to merge 4 commits into from

Conversation

@jmaupetit
Copy link
Contributor

@jmaupetit jmaupetit commented Jan 31, 2024

Proposal

Automate CLI documentation generation using mkdocs-click.

@jmaupetit jmaupetit self-assigned this Jan 31, 2024
@changeset-bot
Copy link

changeset-bot bot commented Jan 31, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: e601f86

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jmaupetit @wilbrdt
📝(api) add CLI documentation
b43488f 
Automate CLI documentation.
@wilbrdt wilbrdt marked this pull request as ready for review July 18, 2024 13:56
@wilbrdt wilbrdt requested a review from quitterie-lcs July 18, 2024 13:57
@wilbrdt wilbrdt self-assigned this Jul 18, 2024
@wilbrdt wilbrdt force-pushed the add-cli-docs branch 2 times, most recently from b3dc0f9 to bfd568c Compare July 18, 2024 15:59
quitterie-lcs
quitterie-lcs reviewed Jul 29, 2024
View reviewed changes
wilbrdt added 2 commits July 29, 2024 17:52
@wilbrdt
fixup! 📝(api) add CLI documentation
d81ff6a
@wilbrdt
🔧(project) add defaults to lrs settings
e4f79ad 
Settings regarding the LRS were missing default values, which can be a problem
when loading Ralph modules for building CLI documentation.
Adding some default values to them.
@jmaupetit jmaupetit removed their assignment Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@quitterie-lcs quitterie-lcs quitterie-lcs left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

@wilbrdt wilbrdt

Labels

FUN WIP

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jmaupetit @quitterie-lcs @wilbrdt