sec0uth / brick-abode-project-interview

The final project of interviewing process
0 stars 0 forks source link

Generate python documentation with PyDoc #19

Closed sec0uth closed 3 years ago

sec0uth commented 3 years ago

Branch [pydoc-html-#19]()

Description

Create a mechanism to generate documentation with PyDoc.

Specification

Use current container infrastructure to easily start the builtin PyDoc server.

The following service is used to start the http server listening on host at 0.0.0.0:8080.

juniper-pydoc:
    extends:
      file: ./juniper/docker-compose.yaml
      service: dev
    command: start-pydoc-server.sh
    ports:
      - 8080:8080

You can start the service with:

$ podman-compose run juniper-pydoc

And then open your browser at http://localhost:8080.

image