Skip to content

v1: Documentation with mkdocs #5466

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 81 commits into
base: main
Choose a base branch
from
Open

v1: Documentation with mkdocs #5466

wants to merge 81 commits into from

Conversation

ndonkoHenri
Copy link
Contributor

No description provided.

selectedColor: widget.control.getColor("selected_color", context),
selectedShadowColor:
widget.control.getColor("selected_shadow_color", context),
shadowColor: widget.control.getColor("shadow_color", context),
shape: widget.control.getShape("shape", Theme.of(context)),
color: widget.control.getWidgetStateColor("color", Theme.of(context)),
surfaceTintColor: widget.control.getColor("surface_tint_color", context),
pressElevation: widget.control.getDouble("click_elevation"),
pressElevation: widget.control.getDouble("elevation_on_click"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the same property name as in Flutter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really.
onPress -> on_click

@FeodorFitsner
Copy link
Contributor

Some design notes:

"attr" labels in front of properties look a bit "aggressive":

image

I would put them behind property name and maybe renamed to property in more light color, like Pydantic did:

image

so, when I glance at the page I first see property name and not "attr".

The same for methods.

@FeodorFitsner

This comment was marked as resolved.

@FeodorFitsner
Copy link
Contributor

FeodorFitsner commented Jul 22, 2025

I'm wondering is it possible to take class description and output it at the top of the page?
Examples right after page title, without any into, look a bit out of place.

image

This is how it looks now:

image

@ndonkoHenri
Copy link
Contributor Author

I'm wondering is it possible to take class description and output it at the top of the page?

Tried ::: flet.Switch.__doc__ but it made mkdocs break. I asked: mkdocstrings/python#302

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

v1: Replace OptionalX with Optional[X] throughout codebase
3 participants