BeeWare Docs Ferramentas Demonstração seção um: página dois¶

Rodapé e links de navegação¶

A navegação deve ser exibida na parte inferior da página; “BeeWare Docs Tools Demo Section One” deve estar à esquerda e “Section Two” à direita. O rodapé deve estar abaixo dos links de navegação. Isso confirma que a configuração do tema foi aplicada.

Documentação de referência da classe¶

O seguinte deve mostrar a documentação de referência para a classe DocsTest, localizada em docs_test.py, no diretório src/beeware_docs_tools. Isso verifica se o diretório do código-fonte com links simbólicos está funcionando corretamente.

Verifique se o texto na tabela de parâmetros está sendo renderizado no mesmo tamanho que o restante da fonte.

beeware_docs_tools.docs_test.DocsTest ¶

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

This is the test class.

PARAMETER	DESCRIPTION
`arg1`	A value. TYPE: `int`
`arg2`	A value with a default. TYPE: `int` DEFAULT: `42`
`kwargs`	keyword arguments DEFAULT: `{}`

attribute `property` ¶

attribute: int

This is a test attribute.

method ¶

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

This is a test method.

PARAMETER	DESCRIPTION
`arg1`	A value. TYPE: `int`
`arg2`	A value with a default. TYPE: `int` DEFAULT: `42`
`kwargs`	keyword arguments DEFAULT: `{}`

Funcionalidade macro¶

O seguinte deve dizer “Brutus diz ‘Olá, mundo!’”. Isso confirma que as variáveis globais e macros definidas via MkDocs-Macros estão disponíveis.

Brutus diz “Hello world!”