Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove visual distraction from docs #777

Conversation

Projects
None yet
2 participants
@cburgdorf
Copy link
Contributor

commented Jul 9, 2019

What was wrong?

I personally find the theme of the API docs a bit visual distracting (and I say that as someone who usually doesn't give a 馃挬 about visuals). Imho, the default Python docs look much cleaner and so I went on to steal some bits.

(I tried stealing the whole theme but it's too heavily customized for a quick win).

Here's how API docs currently look.

image

How was it fixed?

This PR adds a tiny bit of custom css to

  • get rid of these gray boxes for methods
  • get rid of some margin/padding around method names
  • increase size of method/class names
  • use mono space font for method parameters

Here is what it would look like if this PR lands

image

To-Do

  • Clean up commit history

Cute Animal Picture

put a cute animal picture link inside the parentheses

@cburgdorf cburgdorf force-pushed the cburgdorf:christoph/docs/remove-visual-distraction branch from 0a33e97 to 71fbf0a Jul 9, 2019

@cburgdorf cburgdorf requested review from pipermerriam and carver Jul 9, 2019

@cburgdorf cburgdorf force-pushed the cburgdorf:christoph/docs/remove-visual-distraction branch from 71fbf0a to da6a914 Jul 9, 2019

@carver

carver approved these changes Jul 9, 2019

Copy link
Contributor

left a comment

No objections. Mono-spaced italics font for the parameters looks a bit odd to me, but nothing worth holding back the PR for.

@cburgdorf cburgdorf force-pushed the cburgdorf:christoph/docs/remove-visual-distraction branch from da6a914 to ca15d90 Jul 9, 2019

@cburgdorf

This comment has been minimized.

Copy link
Contributor Author

commented Jul 9, 2019

Mono-spaced italics font for the parameters looks a bit odd to me,

I took that straight here and liked it (but also didn't think about it much)

https://github.com/python/python-docs-theme/blob/b862f1159388ed3134818e56b065e18b835d652c/python_docs_theme/static/pydoctheme.css#L191-L193

But now I took a second look and noticed that on the live site they actually only do the mono space for the module / class name part. I rolled that one back. The main issue I had was with these gray boxes and big spacing.

@cburgdorf cburgdorf force-pushed the cburgdorf:christoph/docs/remove-visual-distraction branch from ca15d90 to ed27de4 Jul 9, 2019

@cburgdorf cburgdorf merged commit 24ac7d8 into ethereum:master Jul 9, 2019

32 checks passed

ci/circleci: docker-image-build-test Your tests passed on CircleCI!
Details
ci/circleci: py36-docs Your tests passed on CircleCI!
Details
ci/circleci: py36-eth1-core Your tests passed on CircleCI!
Details
ci/circleci: py36-eth1-plugins Your tests passed on CircleCI!
Details
ci/circleci: py36-eth2-core Your tests passed on CircleCI!
Details
ci/circleci: py36-eth2-integration Your tests passed on CircleCI!
Details
ci/circleci: py36-eth2-plugins Your tests passed on CircleCI!
Details
ci/circleci: py36-integration Your tests passed on CircleCI!
Details
ci/circleci: py36-lightchain_integration Your tests passed on CircleCI!
Details
ci/circleci: py36-lint Your tests passed on CircleCI!
Details
ci/circleci: py36-long_run_integration Your tests passed on CircleCI!
Details
ci/circleci: py36-p2p Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-blockchain Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-byzantium Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-constantinople Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-frontier Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-homestead Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-petersburg Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-spurious_dragon Your tests passed on CircleCI!
Details
ci/circleci: py36-rpc-state-tangerine_whistle Your tests passed on CircleCI!
Details
ci/circleci: py36-wheel-cli Your tests passed on CircleCI!
Details
ci/circleci: py37-eth1-core Your tests passed on CircleCI!
Details
ci/circleci: py37-eth1-plugins Your tests passed on CircleCI!
Details
ci/circleci: py37-eth2-core Your tests passed on CircleCI!
Details
ci/circleci: py37-eth2-integration Your tests passed on CircleCI!
Details
ci/circleci: py37-eth2-plugins Your tests passed on CircleCI!
Details
ci/circleci: py37-lint Your tests passed on CircleCI!
Details
ci/circleci: py37-p2p Your tests passed on CircleCI!
Details
ci/circleci: py37-rpc-state-quadratic Your tests passed on CircleCI!
Details
ci/circleci: py37-rpc-state-sstore Your tests passed on CircleCI!
Details
ci/circleci: py37-rpc-state-zero_knowledge Your tests passed on CircleCI!
Details
ci/circleci: py37-wheel-cli Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.