An open API service indexing awesome lists of open source software.

https://github.com/davidvujic/python-polylith-docs

Documentation: Python tools for the Polylith Architecture
https://github.com/davidvujic/python-polylith-docs

documentation-site monorepo poetry polylith python

Last synced: about 1 year ago
JSON representation

Documentation: Python tools for the Polylith Architecture

Awesome Lists containing this project

README

          

# Documentation: Python tools for the Polylith Architecture

This repo contains the docs for the [Python tools for the Polylith Architecture](https://github.com/DavidVujic/python-polylith) project.
Using MKDocs, a static site generator, and the Material theme.

## Usage
Create a virtual environment:

``` shell
python3 -m venv .venv

source .venv/bin/activate
```

Install Material for MKDocs:

``` shell
pip install mkdocs-material
```

Run the site on your local machine:

``` shell
mkdocs serve
```

## More info
See the [Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/) guide at the _Material for MKDocs_ site.