File: api.md

package info (click to toggle)
mkdocs-test 0.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 436 kB
  • sloc: python: 938; sh: 34; makefile: 5
file content (52 lines) | stat: -rw-r--r-- 1,129 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# API Reference for MkDocs Test

## Introduction

This page describes components of the MkDocs-Test API used by testing
components.

A single MkDocs **project** contains a number of **pages**. 
Each page is a composite of the Markdown version, the metadata,
and the fully formed HTML page that will be displayed on a browser.

## Class: DocProject 

### :::mkdocs_test.DocProject
    selection:
        members:
            - __init__
            - project_dir
            - docs_dir
            - test_dir
            - config_file
            - config
            - get_plugin
            - build
            - build_result
            - success
            - pages
            - get_page
            - trace
            - log
            - log_severities
            - find_entries
            - find_entry
            - self_check

## Class: MkDocsPage

### :::mkdocs_test.MkDocsPage

## Class: LogEntry

This Dataclass describes the attributes of a log entry.

### :::mkdocs_test.LogEntry


## Function: lorem_ipsum()

### ::: mkdocs_test.lorem_ipsum
    options:
        show_signature: true
        show_root_heading: true