-
Notifications
You must be signed in to change notification settings - Fork 0
Create MkDocs documentation site #13
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Set up a documentation site using MkDocs with Material theme for comprehensive project documentation.
Structure
docs/
├── index.md # Home page
├── getting-started.md # Installation & quick start
├── user-guide/
│ ├── sync-client.md # IcapClient usage
│ ├── async-client.md # AsyncIcapClient usage
│ └── scanning.md # File/bytes/stream scanning
├── pytest-plugin/
│ ├── fixtures.md # Available fixtures
│ └── markers.md # Custom markers
├── api/ # API reference (mkdocstrings)
└── changelog.md
Dependencies
[dependency-groups]
docs = [
"mkdocs>=1.5.0",
"mkdocs-material>=9.0.0",
"mkdocstrings[python]>=0.24.0",
]Priority
Low - Enhancement for better user documentation.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation