Skip to content

Style notes using admonition in the documentation #9846

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.

Sign up for GitHub

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

Jump to bottom
Merged
browniebroke merged 3 commits into from
Dec 12, 2025
Merged

Style notes using admonition in the documentation #9846

browniebroke merged 3 commits into from
Dec 12, 2025
+211 −302

Conversation

@browniebroke
Copy link
Member

@browniebroke browniebroke commented Dec 9, 2025

browniebroke
browniebroke commented Dec 9, 2025
View reviewed changes
docs/api-guide/renderers.md
Note that views that have nested or list serializers for their input won't work well with the `AdminRenderer`, as the HTML forms are unable to properly support them.

**Note**: The `AdminRenderer` is only able to include links to detail pages when a properly configured `URL_FIELD_NAME` (`url` by default) attribute is present in the data. For `HyperlinkedModelSerializer` this will be the case, but for `ModelSerializer` or plain `Serializer` classes you'll need to make sure to include the field explicitly. For example here we use models `get_absolute_url` method:
!!! note
Copy link
Member Author

@browniebroke browniebroke Dec 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This one includes a code snippet:

Image

@p-r-a-v-i-n
Copy link
Contributor

p-r-a-v-i-n commented Dec 9, 2025

Hi Bruno, I think there are still 9 files in which we should update the same

these are the files:

authentication.md, 
caching.md, fields.md,
generic-views.md,
requests.md, 
contributing.md
1-serialization.md
4-authentication-and-permissions.md
5-relationships-and-hyperlinked-apis.md

please confirm from your end

browniebroke
browniebroke commented Dec 10, 2025
View reviewed changes
docs/tutorial/1-serialization.md
```

**Note:** To exit the virtual environment at any time, just type `deactivate`. For more information see the [venv documentation][venv].
!!! tip
Copy link
Member Author

@browniebroke browniebroke Dec 10, 2025

Choose a reason for hiding this comment

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

Here is how "tip" are styled

Image

@browniebroke
Copy link
Member Author

browniebroke commented Dec 10, 2025 •
edited
Loading

Hi Bruno, I think there are still 9 files in which we should update the same

Thanks Pravin, not sure how I missed these. There was also a few more which I've also updated.

I've also added a "tip" style which is sometimes a bit more appropriate than "note"

@browniebroke browniebroke mentioned this pull request Dec 10, 2025
Open
@p-r-a-v-i-n
Copy link
Contributor

p-r-a-v-i-n commented Dec 10, 2025

I've also added a "tip" style which is sometimes a bit more appropriate than "note"

Indeed. every looks great

p-r-a-v-i-n
p-r-a-v-i-n reviewed Dec 10, 2025
View reviewed changes
peterthomassen
peterthomassen approved these changes Dec 11, 2025
View reviewed changes
Copy link
Collaborator

@peterthomassen peterthomassen left a comment

Choose a reason for hiding this comment

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

beautiful!

@browniebroke browniebroke merged commit e221d9a into encode:main Dec 12, 2025
7 checks passed
@browniebroke browniebroke deleted the docs/admonition-notes branch December 12, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@peterthomassen peterthomassen peterthomassen approved these changes

@auvipy auvipy Awaiting requested review from auvipy

+1 more reviewer

@p-r-a-v-i-n p-r-a-v-i-n p-r-a-v-i-n left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@browniebroke @p-r-a-v-i-n @peterthomassen