Skip to content

Commit

Permalink
#13 The generator of API documentation was implemented
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim55667757 committed Jan 4, 2023
1 parent 0abd1bb commit 227bfff
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions PDocBuilder.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# -*- coding: utf-8 -*-
# Author: Timur Gilmullin

"""
A coroutine that generates the API documentation for the PriceGenerator module using pdoc-engine: https://pdoc.dev/docs/pdoc.html
To build new documentation:
1. Remove the `./docs` directory from the repository root.
2. Go to the root of the repository.
3. Just run: `python PDocBuilder.py`.
"""


import os
import sys
import pdoc
from pathlib import Path


curdir = os.path.curdir

sys.path.extend([
curdir,
os.path.abspath(os.path.join(curdir, "pricegenerator")),
])

pdoc.pdoc(
Path("pricegenerator").resolve(),
output_directory=Path("docs").resolve(),
)

0 comments on commit 227bfff

Please sign in to comment.