Welcome to docs-example’s documentation!

Introduction

Installation

Prerequisites

Installation

Verification

How to say hello

>>> from docs_example.example1 import say_hello
>>> say_hello()
hello

How to say hi

>>> from docs_example.example1 import say_hi
>>> say_hi()
hi

Sphinx Extension

mermaid

| https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/

sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts <br/>prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good!

English

简体中文

docs_example.example1

docs_example.example1.say_hello(n: int = 1)

Print hello n times to terminal.

Parameters

n (int) – Print hello n times to terminal.

docs_example.example2

docs_example.example2.say_hi(n: int = 1)

Print hi n times to terminal.

Parameters

n (int) – Print hi n times to terminal.

docs_example.style_guide

ExampleClass	The summary line for a class docstring should fit on one line.
example_generator	Generators have a Yields section instead of a Returns section.
module_level_function	This is an example of a module level function.

Indices and tables

• Index

• Module Index

• Search Page