ethereum / web3.py

A python interface for interacting with the Ethereum blockchain and ecosystem.
http://web3py.readthedocs.io
MIT License
5.01k stars 1.71k forks source link

Broken docs styles #1968

Closed wolovim closed 3 years ago

wolovim commented 3 years ago

What was wrong?

Some of the styling in the docs broke recently.

For example, landing page should look like:

Screen Shot 2021-04-28 at 12 45 41 PM

but instead looks like:

Screen Shot 2021-04-28 at 12 45 52 PM

How can it be fixed?

Unsure yet, but building the docs locally works fine (make docs).

tserg commented 3 years ago

I tried running make doctest locally and got the following errors:

WARNING: Failed to get a method signature for ethpm.Package.build_dependencies: <ethpm._utils.cache.cached_property object at 0x7f50b9674ac0> is not a callable object WARNING: Failed to get a method signature for ethpm.Package.deployments: <ethpm._utils.cache.cached_property object at 0x7f50b9674b20> is not a callable object

Making the following changes to ethpm.rst resolves the errors:

Original

.. autoclass:: ethpm.Package
   :members: name, version, manifest_version, uri, __repr__, contract_types, build_dependencies, deployments

Amended

.. autoclass:: ethpm.Package
   :members: name, version, manifest_version, uri, __repr__, contract_types

   .. automethod:: build_dependencies(self)
   .. automethod:: deployments(self)

I am not sure if this is causing the errors though.

kclowes commented 3 years ago

This has been fixed in #1977!