Skip to content

Commit

Permalink
turn notice into an alert
Browse files Browse the repository at this point in the history
  • Loading branch information
mhils committed Jul 24, 2024
1 parent d587515 commit 1848f4e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions pdoc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,10 @@ class GoldenRetriever(Dog):
- If you want to document a special `__dunder__` method, the recommended way to do so is
to not document the dunder method specifically, but to add some usage examples in the class documentation.
> [!NOTE]
> Hiding an item only removes it from documentation.
> It is still displayed in the source code when clicking the "View Source" button.
As a last resort, you can override pdoc's behavior with a custom module template (see
[*How can I edit pdoc's HTML template?*](#edit-pdocs-html-template)).
You can find an example at
Expand Down
2 changes: 1 addition & 1 deletion pdoc/templates/content.css
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
border: 1px solid transparent;
border-radius: .25rem;
background-repeat: no-repeat;
background-position: 1rem center;
background-position: .75rem center;
margin-bottom: 1rem;
}

Expand Down

0 comments on commit 1848f4e

Please sign in to comment.