alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Hide some members from the public docs. (#3080)

Browse Source 
* Hide some members from the public docs.

See relevant issue: #3076.
Some methods need to be implemented to make the widget work but the user doesn't really care about them. For that matter, we can hide them from the public documentation.

* Use private handler to hide from docs.

Related comments: https://github.com/Textualize/textual/pull/3080#issuecomment-1671129733
This commit is contained in:
Rodrigo Girão Serrão
2023-08-15 16:53:14 +01:00
committed by GitHub
parent 54ba3578a6
commit fbe1c416a4
3 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
mkdocs-common.yml
View File

@@ -78,6 +78,15 @@ plugins:
- "!^_"
- "^__init__$"
- "!^can_replace$"
# Hide some methods that Widget subclasses implement but that we don't want
# to be shown in the docs.
# This is then overridden in widget.md so that it shows in the base class.
- "!^compose$"
- "!^render$"
- "!^render_line$"
- "!^render_lines$"
- "!^get_content_width$"
- "!^get_content_height$"
watch:
- mkdocs-common.yml
- mkdocs-nav.yml