.. Basic Report documentation master file, created by
   sphinx-quickstart on Tue Feb 10 19:46:35 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Basic Report |vrelease|
=======================

.. important::
   Keep an eye on the release number. Currently we do not provide support for outdated packages, even though we will try
   not to break any API functionality, but rather only add to the capabilities.

**basic-report** is a lightweight Python package for generating clean, professional static HTML reports with zero
external dependencies. Built using elements of `Bootstrap 4 <https://getbootstrap.com/>`__ (MIT licensed),
`datatables <https://datatables.net/>`__ (MIT licensed), and `cal-heatmap <https://cal-heatmap.com/>`__ (MIT licensed)
it empowers you to create fully self-contained sites that can be served directly by any web server. The focus is set on
simplicity - no oversized web framework, no database, no setup required.


Design any reports entirely in Python using an intuitive top-to-bottom workflow. Simply add elements in the order they 
should appear, and nest them naturally, e.g., tabs within columns, columns within tabs, or any combination you need. The
API follows the logical flow of your document, making more complex layouts straightforward to build.

Perfect for data scientists, analysts, and developers who need to create shareable, standalone reports without the
overhead of modern web frameworks.

.. toctree::
   :maxdepth: 1
   :caption: Contents:
   :hidden:

   page_quickstart
   page_elements
   page_calendar
   page_colors
   page_configuration
   page_example_report
   modules