BeeWare ドキュメント ツール デモ セクション1: ページ2

フッターとナビゲーションリンク

ナビゲーションはページ下部に表示されるべきです。「BeeWare Docs Tools Demo Section One」は左側に、「Section Two」は右側に配置されます。フッターはナビゲーションリンクの下に配置されます。これによりテーマ設定が適用されたことが確認されます。

クラス参照ドキュメント

以下は、DocsTest ディレクトリ内の docs_test.py にある src/beeware_docs_tools クラスのリファレンスドキュメントを表示するはずです。これにより、ソースコードディレクトリのシンボリックリンクが正常に機能していることが確認できます。

パラメータテーブル内のテキストが、フォントの他の部分と同じサイズで表示されていることを確認してください。

beeware_docs_tools.docs_test.DocsTest

DocsTest(arg1: int, arg2: int = 42, **kwargs)

This is the test class.

引数	デスクリプション
arg1	A value. タイプ： int
arg2	A value with a default. タイプ： int デフォルト： 42
kwargs	keyword arguments デフォルト： {}

attribute property

attribute: int

This is a test attribute.

method

method(arg1: int, arg2: int = 42, **kwargs)

This is a test method.

引数	デスクリプション
arg1	A value. タイプ： int
arg2	A value with a default. タイプ： int デフォルト： 42
kwargs	keyword arguments デフォルト： {}

マクロ機能

以下は「Brutus says "Hello world!"」と表示されるはずです。これにより、MkDocs-Macros経由で定義されたグローバル変数とマクロが利用可能であることが確認できます。

Brutusは「Hello world!」と言っている