Skip to content

Commit 6611687

Browse files
committed
fix: project urls
1 parent 3d91da4 commit 6611687

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Thank you for your interest in contributing! This guide will help you get starte
66

77
1. Clone the repository:
88
```bash
9-
git clone https://github.com/yourusername/vyper-sphinx-docs
10-
cd vyper-sphinx-docs
9+
git clone https://github.com/BobTheBuidler/sphinx-autodoc-vyper
10+
cd sphinx-autodoc-vyper
1111
```
1212

1313
2. Create a virtual environment:

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ A documentation generator for Vyper smart contracts using Sphinx. This tool auto
1515

1616
```bash
1717
# Install from PyPI
18-
pip install vyper-sphinx-docs
18+
pip install sphinx-autodoc-vyper
1919

2020
# Install with development dependencies
21-
pip install "vyper-sphinx-docs[dev]"
21+
pip install "sphinx-autodoc-vyper[dev]"
2222
```
2323

2424
## Quick Start

pyproject.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["hatchling"]
33
build-backend = "hatchling.build"
44

55
[project]
6-
name = "vyper-sphinx-docs"
6+
name = "sphinx-autodoc-vyper"
77
version = "0.1.0"
88
description = "Sphinx documentation generator for Vyper smart contracts"
99
readme = "README.md"
@@ -43,9 +43,9 @@ dev = [
4343
vyper-docs = "sphinx_autodoc_vyper.cli:main"
4444

4545
[project.urls]
46-
Homepage = "https://github.com/yourusername/vyper-sphinx-docs"
47-
Repository = "https://github.com/yourusername/vyper-sphinx-docs.git"
48-
Documentation = "https://github.com/yourusername/vyper-sphinx-docs#readme"
46+
Homepage = "https://github.com/BobTheBuidler/sphinx-autodoc-vyper"
47+
Repository = "https://github.com/BobTheBuidler/sphinx-autodoc-vyper.git"
48+
Documentation = "https://github.com/BobTheBuidler/sphinx-autodoc-vyper#readme"
4949

5050
[tool.hatch.build.targets.wheel]
5151
packages = ["sphinx_autodoc_vyper"]

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from setuptools import find_packages, setup
22

33
setup(
4-
name="vyper-sphinx-docs",
4+
name="sphinx-autodoc-vyper",
55
version="0.1.0",
66
packages=find_packages(),
77
install_requires=["sphinx>=4.0.0", "sphinx-rtd-theme>=1.0.0"],
@@ -19,7 +19,7 @@
1919
description="Sphinx documentation generator for Vyper smart contracts",
2020
long_description=open("README.md").read(),
2121
long_description_content_type="text/markdown",
22-
url="https://github.com/yourusername/vyper-sphinx-docs",
22+
url="https://github.com/BobTheBuidler/sphinx-autodoc-vyper",
2323
classifiers=[
2424
"Programming Language :: Python :: 3",
2525
"License :: OSI Approved :: MIT License",

tests/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"""Test suite for vyper-sphinx-docs."""
1+
"""Test suite for sphinx-autodoc-vyper."""

0 commit comments

Comments
 (0)