Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 15 additions & 70 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
.. meta::
:description: Python Web3 SDK for Ethereum and EVM blockchains

Introduction
============

web3.py is a Python library for interacting with Ethereum.
gm
==

**web3.py** is a Python library for interacting with Ethereum.

It's commonly found in `decentralized apps (dapps)`_ to help with
sending transactions, interacting with smart contracts, reading
Expand All @@ -14,87 +15,31 @@ The original API was derived from the `Web3.js`_ Javascript API,
but has since evolved toward the needs and creature comforts of
Python developers.


Getting Started
---------------

Your next steps depend on where you're standing:
.. NOTE::
👋 Brand new to Ethereum?

0. Don't travel alone! Join the Ethereum Python Community `Discord`_.
1. Read this `blog post series`_ for a gentle introduction to Ethereum blockchain concepts.
2. The :ref:`Overview` page will give you a quick idea of what else web3.py can do.
3. Try building a little something!

- Unfamiliar with Ethereum? → `ethereum.org`_
- Looking for Ethereum Python tutorials? → `ethereum.org/python`_
- Ready to code? → :ref:`quickstart`
- Interested in a quick tour? → :ref:`overview`
- Need help debugging? → `StackExchange`_
- Like to give back? → :ref:`Contribute <contributing>`
- Found a bug? → :ref:`Contribute <contributing>`
- Want to chat? → `Discord`_
- Read the source? → `Github`_

Table of Contents
-----------------

.. toctree::
:maxdepth: 1
:caption: Intro

quickstart
overview
releases

.. toctree::
:maxdepth: 1
:caption: Guides

node
providers
examples
troubleshooting
web3.eth.account
filters
web3.contract
abi_types
middleware
internals
ethpm
ens_overview
v6_migration
v5_migration
v4_migration

.. toctree::
:maxdepth: 1
:caption: API

web3.main
web3.eth
web3.beacon
web3.pm
web3.net
web3.miner
web3.geth
web3.tracing
web3.utils
gas_price
ens
constants

.. toctree::
:maxdepth: 1
:caption: Community

contributing
code_of_conduct

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. include:: toc.rst


.. _decentralized apps (dapps): https://ethereum.org/dapps/
.. _Web3.js: https://web3js.readthedocs.io/
.. _ethereum.org: https://ethereum.org/what-is-ethereum/
.. _ethereum.org/python: https://ethereum.org/python/
.. _blog post series: https://snakecharmers.ethereum.org/a-developers-guide-to-ethereum-pt-1
.. _StackExchange: https://ethereum.stackexchange.com/questions/tagged/web3.py
.. _Discord: https://discord.gg/GHryRvPB84
.. _Github: https://github.com/ethereum/web3.py
61 changes: 61 additions & 0 deletions docs/toc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Table of Contents
-----------------

.. toctree::
:maxdepth: 1
:caption: Intro

quickstart
overview
releases

.. toctree::
:maxdepth: 1
:caption: Guides

node
providers
examples
troubleshooting
web3.eth.account
filters
web3.contract
abi_types
middleware
internals
ethpm
ens_overview
v6_migration
v5_migration
v4_migration

.. toctree::
:maxdepth: 1
:caption: API

web3.main
web3.eth
web3.beacon
web3.pm
web3.net
web3.miner
web3.geth
web3.tracing
web3.utils
gas_price
ens
constants

.. toctree::
:maxdepth: 1
:caption: Community

contributing
code_of_conduct

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 1 addition & 1 deletion docs/web3.eth.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
web3.eth API
=============
============

.. py:module:: web3.eth

Expand Down
1 change: 1 addition & 0 deletions newsfragments/2905.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add welcome banner for Ethereum newcomers