Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bobthebuidler/sphinx-autodoc-vyper
Automagically generate documentation for vyper smart contracts. WIP.
https://github.com/bobthebuidler/sphinx-autodoc-vyper
Last synced: about 1 month ago
JSON representation
Automagically generate documentation for vyper smart contracts. WIP.
- Host: GitHub
- URL: https://github.com/bobthebuidler/sphinx-autodoc-vyper
- Owner: BobTheBuidler
- Created: 2024-11-02T13:33:36.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T16:14:09.000Z (about 2 months ago)
- Last Synced: 2024-11-10T17:22:23.704Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Vyper Sphinx Docs
A documentation generator for Vyper smart contracts using Sphinx. This tool automatically parses your Vyper contracts and generates beautiful, searchable documentation using Sphinx with the ReadTheDocs theme.
## Features
- Automatic parsing of Vyper smart contracts
- Extraction of docstrings and function signatures
- Beautiful Sphinx documentation with ReadTheDocs theme
- Support for nested contract directories
- Built-in documentation server
- Comprehensive test suite
## Installation
```bash
# Install from PyPI
pip install sphinx-autodoc-vyper
# Install with development dependencies
pip install "sphinx-autodoc-vyper[dev]"
```
## Quick Start
1. Generate documentation:
```bash
sphinx-autodoc-vyper /path/to/contracts
```
2. Generate and serve documentation:
```bash
sphinx-autodoc-vyper /path/to/contracts --serve
```
## Usage
```bash
# Basic usage
sphinx-autodoc-vyper /path/to/contracts
# Specify custom output directory
sphinx-autodoc-vyper /path/to/contracts -o /path/to/output
# Generate and serve documentation on port 8000
sphinx-autodoc-vyper /path/to/contracts --serve
# Specify custom port
sphinx-autodoc-vyper /path/to/contracts --serve --port 8080
```
## Example
For a Vyper contract like:
```python
"""
A simple ERC20 token implementation.
"""
@external
def transfer(to: address, amount: uint256) -> bool:
"""
@notice
Transfer tokens to a specified address.
@param
to The recipient address
@param
amount The amount of tokens to transfer
@return
True if transfer succeeded
"""
# Implementation
return True
```
The generator will create Sphinx documentation with:
- Contract overview from the main docstring
- Function documentation with parameters and return types
- Proper RST formatting and navigation
- Search functionality
- Mobile-friendly responsive design
## Documentation Structure
The generated documentation follows this structure:
```
docs/
├── _build/ # Built HTML documentation
├── _static/ # Static assets
├── _templates/ # Sphinx templates
├── conf.py # Sphinx configuration
├── index.rst # Main index
└── contracts/ # Generated contract docs
```
## Requirements
- Python 3.7+
- Sphinx
- sphinx-rtd-theme
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
## License
MIT License - see LICENSE file for details