-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Does this suggestion already exist?
- This is a new feature!
Feature description
The current Sphinx-generated API reference is useful for learning basic usage patterns of the package.
However, there are many features of Feud, or ways to combine features that can be used in more complex usage patterns to achieve many different things in the generated CLI.
These detailed usage examples don't belong in the API reference, and should be contained in a separate user guide.
The user guide should also show integrations (which should work in theory), e.g. click-contrib and trogon.
Proposed stack
- mkdocs
- mkdocs-material: Material design for
mkdocs - koaning/mktestdocs:
doctestbut formkdocs - jimporter/mike: multi-version
mkdocsdocumentation - mkdocs-plugins/termynal: terminal window plugin for code blocks
- mkdocs-material: Material design for
Hosted at feud.wiki/guide or guide.feud.wiki.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request