Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

[Feature Request]: Use mkdocs #22

Closed
1 task done
osfanbuff63 opened this issue Oct 16, 2022 · 0 comments · Fixed by #29
Closed
1 task done

[Feature Request]: Use mkdocs #22

osfanbuff63 opened this issue Oct 16, 2022 · 0 comments · Fixed by #29
Assignees
@osfanbuff63
Labels
enhancement New feature or request
Milestone
Full Release

Comments

@osfanbuff63
Copy link
Member

osfanbuff63 commented Oct 16, 2022 •
edited
Loading

Code of Conduct

Potential Enhancement

Especially if we're going to publish to PyPi (#21), we should provide some sort of documentation. An easy way to generate this is mkdocs, especially with mkdocstrings to auto-generate documentation from the code itself.

How it could be implemented

Covered above, but mkdocs and the plugin mkdocstrings.

Anything else?

No response
@osfanbuff63 osfanbuff63 added the enhancement New feature or request label Oct 16, 2022
@osfanbuff63 osfanbuff63 self-assigned this Oct 16, 2022
@osfanbuff63 osfanbuff63 added this to the Full Release milestone Oct 16, 2022
@osfanbuff63 osfanbuff63 mentioned this issue Oct 21, 2022
Merged
@nsde nsde closed this as completed in #29 Oct 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@osfanbuff63 osfanbuff63

Labels
enhancement New feature or request
Projects
None yet
Milestone
Full Release
Development

Successfully merging a pull request may close this issue.

Use mkdocs and add gitpod configuration Fabulously-Optimized/vanilla-installer-python
1 participant
@osfanbuff63