financial-reports

Documentation site built with MkDocs and the Material theme.

Quick Start

Prerequisites

• Python 3.8+
• pip

Setup

1. Clone the repository

   git clone https://github.com/ovesorg/financial-reports.git
   cd financial-reports

2. Install dependencies

   pip install -r requirements.txt

3. Serve locally

   mkdocs serve

   Documentation will be available at http://127.0.0.1:8000

Build

To build the static site:

mkdocs build --clean

Output will be in the site/ directory.

Project Structure

.
├── docs/              # Documentation source files
│   └── adr/           # Progressive architecture decisions for this repo
│   └── reference/     # Terminology and important external references
├── overrides/         # Theme customization
│   ├── javascripts/   # Custom JavaScript
│   ├── partials/      # Template overrides
│   └── stylesheets/   # Custom CSS
├── mkdocs.yml         # MkDocs configuration
├── requirements.txt   # Python dependencies
└── README.md          # This file

Utilities

KRR (Kill, Rebuild, Restart)

Clean rebuild and restart the documentation server:

mkdocs-oves-krr

PlantUML Rendering

Render PlantUML diagrams:

mkdocs-oves-render

Contributing

1. Edit Markdown files in docs/
2. Record architecture decisions in docs/adr/ when they change repo direction
3. Keep terminology and important external references under docs/reference/
4. Keep Reference as the last top-level section in mkdocs.yml
5. Test locally with mkdocs serve
6. Commit and push changes

Support

For issues or questions, please open an issue in this repository.