Skip to content

Commit fe8b00b

Browse files
authored
Add context to index.rst and docs categories (#1671)
* add context to index.rst and docs categories * add newsfragment
1 parent aa30b3b commit fe8b00b

File tree

3 files changed

+51
-16
lines changed

3 files changed

+51
-16
lines changed

docs/index.rst

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,70 @@
1-
Web3.py
2-
=======
1+
Introduction
2+
============
33

4-
Web3.py is a python library for interacting with Ethereum. Its API is derived
5-
from the `Web3.js`_ Javascript API and should be familiar to anyone who has
6-
used ``web3.js``.
4+
Web3.py is a Python library for interacting with Ethereum.
75

6+
It's commonly found in `decentralized apps (dapps)`_ to help with
7+
sending transactions, interacting with smart contracts, reading
8+
block data, and a variety of other use cases.
89

9-
Contents
10-
--------
10+
The original API was derived from the `Web3.js`_ Javascript API,
11+
but has since evolved toward the needs and creature comforts of
12+
Python developers.
13+
14+
Getting Started
15+
---------------
16+
17+
Your next steps depend on where you're standing:
18+
19+
- Unfamiliar with Ethereum? `ethereum.org`_
20+
- Looking for Ethereum Python tutorials? `ethereum.org/python`_
21+
- Ready to code? :ref:`quickstart`
22+
- Need help debugging? `StackExchange`_
23+
- Want to chat? `Gitter`_
24+
25+
Table of Contents
26+
-----------------
1127

1228
.. toctree::
1329
:maxdepth: 1
30+
:caption: Intro
1431

1532
quickstart
1633
overview
34+
releases
35+
36+
.. toctree::
37+
:maxdepth: 1
38+
:caption: Guides
39+
1740
node
1841
providers
1942
examples
2043
troubleshooting
21-
v5_migration
22-
v4_migration
44+
web3.eth.account
2345
filters
2446
contracts
25-
ens_overview
2647
middleware
48+
internals
49+
abi_types
50+
ethpm
51+
ens_overview
52+
v5_migration
53+
v4_migration
54+
55+
.. toctree::
56+
:maxdepth: 1
57+
:caption: API
58+
2759
web3.main
2860
web3.eth
29-
web3.eth.account
3061
web3.pm
3162
web3.net
3263
web3.miner
3364
web3.geth
3465
web3.parity
3566
gas_price
3667
ens
37-
ethpm
38-
internals
39-
abi_types
40-
releases
4168

4269
Indices and tables
4370
------------------
@@ -47,4 +74,9 @@ Indices and tables
4774
* :ref:`search`
4875

4976

50-
.. _Web3.js: https://github.com/ethereum/wiki/wiki/JavaScript-API
77+
.. _decentralized apps (dapps): https://ethereum.org/dapps/
78+
.. _Web3.js: https://web3js.readthedocs.io/
79+
.. _ethereum.org: https://ethereum.org/what-is-ethereum/
80+
.. _ethereum.org/python: https://ethereum.org/python/
81+
.. _StackExchange: https://ethereum.stackexchange.com/questions/tagged/web3.py
82+
.. _Gitter: https://gitter.im/ethereum/web3.py

docs/quickstart.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _quickstart:
2+
13
Quickstart
24
==========
35

newsfragments/1671.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Breaks up links into three categories (Intro, Guides, and API) and adds content to the index page: a lib introduction and some "Getting Started" links.

0 commit comments

Comments
 (0)