One-Prompt-Medical-Image-Segmentation/docs/README.md

Documentation

This directory contains the project documentation.

Structure

docs/
├── api/                  # API reference documentation
├── guides/               # User guides and tutorials
├── examples/             # Example code and notebooks
└── index.rst             # Main documentation index

Building Documentation

To build the documentation locally:

cd docs
pip install sphinx sphinx-rtd-theme
make html

The built documentation will be available in docs/_build/html/.

Documentation Style

• Use Google-style docstrings for all modules, classes, and functions
• Include type hints in function signatures
• Provide examples in docstrings where appropriate