Skip to content

Add docc plugin that automatically links to an EIP when it is mentioned #2153

@SamWilsn

Description

@SamWilsn

We reference EIPs everywhere throughout the documentation, and every time we do, we need to link to it. For example:

FLOOR_CALLDATA_COST = Uint(15)
"""
Minimum gas cost per byte of calldata as per [EIP-7976]. Used to calculate
the minimum gas cost for transactions that include calldata.

[EIP-7976]: https://eips.ethereum.org/EIPS/eip-7976
"""

It would be fairly easy to add a new docc plugin, like the ones in here, that automatically finds text of the form (EIP|ERC)-[0-9]+ and makes it a link to the relevant EIP.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docArea: documentationC-featCategory: an improvement or new featureE-mediumExperience: of moderate difficultyP-lowstaleThe Issue/PR has not had any activity for 60 days. PRs will be automatically closed.
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions