Commit 6611687 1 parent 3d91da4 commit 6611687 Copy full SHA for 6611687
File tree 5 files changed +11
-11
lines changed
5 files changed +11
-11
lines changed Original file line number Diff line number Diff line change @@ -6,8 +6,8 @@ Thank you for your interest in contributing! This guide will help you get starte
6
6
7
7
1 . Clone the repository:
8
8
``` 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
11
11
```
12
12
13
13
2 . Create a virtual environment:
Original file line number Diff line number Diff line change @@ -15,10 +15,10 @@ A documentation generator for Vyper smart contracts using Sphinx. This tool auto
15
15
16
16
``` bash
17
17
# Install from PyPI
18
- pip install vyper- sphinx-docs
18
+ pip install sphinx-autodoc-vyper
19
19
20
20
# Install with development dependencies
21
- pip install " vyper- sphinx-docs [dev]"
21
+ pip install " sphinx-autodoc-vyper [dev]"
22
22
```
23
23
24
24
## Quick Start
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ requires = ["hatchling"]
3
3
build-backend = " hatchling.build"
4
4
5
5
[project ]
6
- name = " vyper- sphinx-docs "
6
+ name = " sphinx-autodoc-vyper "
7
7
version = " 0.1.0"
8
8
description = " Sphinx documentation generator for Vyper smart contracts"
9
9
readme = " README.md"
@@ -43,9 +43,9 @@ dev = [
43
43
vyper-docs = " sphinx_autodoc_vyper.cli:main"
44
44
45
45
[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"
49
49
50
50
[tool .hatch .build .targets .wheel ]
51
51
packages = [" sphinx_autodoc_vyper" ]
Original file line number Diff line number Diff line change 1
1
from setuptools import find_packages , setup
2
2
3
3
setup (
4
- name = "vyper- sphinx-docs " ,
4
+ name = "sphinx-autodoc-vyper " ,
5
5
version = "0.1.0" ,
6
6
packages = find_packages (),
7
7
install_requires = ["sphinx>=4.0.0" , "sphinx-rtd-theme>=1.0.0" ],
19
19
description = "Sphinx documentation generator for Vyper smart contracts" ,
20
20
long_description = open ("README.md" ).read (),
21
21
long_description_content_type = "text/markdown" ,
22
- url = "https://github.com/yourusername/vyper- sphinx-docs " ,
22
+ url = "https://github.com/BobTheBuidler/ sphinx-autodoc-vyper " ,
23
23
classifiers = [
24
24
"Programming Language :: Python :: 3" ,
25
25
"License :: OSI Approved :: MIT License" ,
Original file line number Diff line number Diff line change 1
- """Test suite for vyper- sphinx-docs ."""
1
+ """Test suite for sphinx-autodoc-vyper ."""
You can’t perform that action at this time.
0 commit comments