PriceGenerator

1
# -*- coding: utf-8 -*-
2
# Author: Timur Gilmullin
3

4
"""
5
A coroutine that generates the API documentation for the PriceGenerator module using pdoc-engine: https://pdoc.dev/docs/pdoc.html
6

7
To build new documentation:
8
1. Remove the `./docs` directory from the repository root.
9
2. Go to the root of the repository.
10
3. Just run: `python PDocBuilder.py`.
11
"""
12

13

14
import os
15
import sys
16
import pdoc
17
from pathlib import Path
18

19

20
curdir = os.path.curdir
21

22
sys.path.extend([
23
    curdir,
24
    os.path.abspath(os.path.join(curdir, "pricegenerator")),
25
])
26

27
pdoc.render.configure(
28
    docformat="restructuredtext",
29
    favicon="https://github.com/Tim55667757/PriceGenerator/blob/develop/media/logo-pricegenerator-256x256px.png?raw=true",
30
    footer_text="⚙ Good luck for you in trade automation! And profit!",
31
    logo="https://github.com/Tim55667757/PriceGenerator/blob/develop/media/logo-pricegenerator-420x610px.png?raw=true",
32
    show_source=False,
33
)
34
pdoc.pdoc(
35
    Path("pricegenerator").resolve(),
36
    output_directory=Path("docs").resolve(),
37
)
38