Skip to content

Datuanalytics/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This repository contains the documentation for the datu core. The documentation is built using MkDocs and provides guides, examples, and API references.

The official documentation is available online at: TODO

Local Development

Prerequisites

  • Python 3.10+

Setup and Installation

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate

pip install -r requirements.txt

Building and Previewing

To generate the static site:

mkdocs build

This will create the site in the site directory.

To run a local development server:

mkdocs serve

This will start a server at http://127.0.0.1:8000/ for previewing the documentation.

Contributing ❤️

We welcome contributions! See our Contributing Guide for details on:

  • Reporting bugs & features
  • Development setup
  • Contributing via Pull Requests
  • Code of Conduct
  • Reporting of security issues

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Security

See CONTRIBUTING for more information.

About

Documentation for the Datu core.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5