ApeWorX / ApeWorX/web3.py

Web3.py intersphinx fails to resolve some objects

Open
#2,532 4 comments 0 reactions 0 assignees View on GitHub
priority: p2 normal
Dominant language
Python
Stars
5.5k
Forks
1.7k
Avg merge
3d 10h
Merged PRs (30d)
2

Description

### What was wrong?

[I am writing a library that depends on Web3.py](https://web3-ethereum-defi.readthedocs.io/). The library Sphinx documentation refers to Web3 documentation using [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html).

* Some objects get resolved like `web3.Contract`
* some objects do not get resolved like `web3.Web3`

`Web3` not resolved (no link):

image

`web3.contract.Contract` correctly resolved (has link):

image

### How can it be fixed?

I have no idea not. There might be some ways to fine-tune Sphinx documentation generation to be able to map aliased, etc. imports that may cause the issues in object resolution.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.