ethereum / execution-specs

Specification for the Execution Layer. Tracking network upgrades.
Creative Commons Zero v1.0 Universal
809 stars 223 forks source link

Make the switch to `docc` #833

Closed SamWilsn closed 5 months ago

SamWilsn commented 10 months ago

What changed?

This rips out sphinx and replaces it with docc.

Opening this as a draft because I'm still waiting on a few upstream PRs to merge.

Review Suggestions

I very strongly suggest doing this review one commit at a time. Several commits are just fixing formatting/flake8 problems that came up after updating the packages.

Cute Animal Picture

cat

codecov-commenter commented 8 months ago

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (3fe6514) 74.10% compared to head (1fcbcf9) 74.11%.

Files Patch % Lines
src/ethereum/arrow_glacier/fork.py 0.00% 2 Missing :warning:
src/ethereum/gray_glacier/fork.py 0.00% 2 Missing :warning:
src/ethereum/arrow_glacier/trie.py 0.00% 1 Missing :warning:
src/ethereum/crypto/finite_field.py 66.66% 1 Missing :warning:
src/ethereum/dao_fork/trie.py 0.00% 1 Missing :warning:
src/ethereum/gray_glacier/trie.py 0.00% 1 Missing :warning:
src/ethereum/muir_glacier/trie.py 0.00% 1 Missing :warning:
src/ethereum/rlp.py 90.90% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #833 +/- ## ========================================== + Coverage 74.10% 74.11% +0.01% ========================================== Files 572 572 Lines 32028 32411 +383 ========================================== + Hits 23733 24022 +289 - Misses 8295 8389 +94 ``` | [Flag](https://app.codecov.io/gh/ethereum/execution-specs/pull/833/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ethereum) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/ethereum/execution-specs/pull/833/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ethereum) | `74.11% <82.45%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ethereum#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.