Quickstart

Installation

This explains how to get a local copy of this documentation, so that use cases and co. can be extended.

Prerequirement: Python and Rye must be installed to build the documentation.

1. Checkout the repository: git clone https://github.com/patdhlk/Dahlke.PressCenter, cloneing with ssh is recommended

2. cd Dahlke.PressCenter

3. rye init, this will create a virtuakl Python environment and installs all needed dependencies.

4. Build the docs via cd docs and rye run sphinx-build -a -E -b html . _build/html.

5. Open _build/html/index.html with your browser of choice.

Usage

The documentation can be used as it is. And for sure also extended.

Extending the documentation is the most important use case, as your project grows over time.