# labbdocs
The documentation is available online at [https://labb.io/docs](https://labb.io/docs).
This documentation is installed as a django app in the django project that powers the [labb.io](https://labb.io) website.
## Installation
```bash
pip install labbdocs
```
## Integration with a django site
### 1. Add to INSTALLED_APPS
Add `labbdocs` to your Django project's `INSTALLED_APPS`:
```python
# settings.py
INSTALLED_APPS = [
# ... other apps
'labbdocs',
]
```
### 2. Configure LABB_DOCS
Set up your documentation configuration in your Django settings:
```python
# settings.py
LABB_DOCS = {
"ui": {
"config": "/path/to/your/ui.yaml",
"title": "UI Components",
"name": "ui",
"url_prefix": "/docs/ui",
"template_dir": "labbdocs/docs/ui/",
"build_path": "/path/to/templates/build/docs/ui"
},
"icons": {
"config": "/path/to/your/icons.yaml",
"title": "Icon Library",
"name": "icons",
"url_prefix": "/docs/icons",
"template_dir": "labbdocs/docs/icons/",
"build_path": "/path/to/templates/build/docs/icons"
}
}
```
### 3. Include URLs
Add labbdocs URLs to your main URL configuration:
```python
# urls.py
from django.urls import path, include
urlpatterns = [
# ... other patterns
path("", include("labbdocs.urls")),
]
```
### 4. Build Documentation
Use the management command to build your documentation:
```bash
# Build all documentation
python manage.py build_docs ui
python manage.py build_docs icons
# Or build with quiet output
python manage.py build_docs ui --quiet
```
Raw data
{
"_id": null,
"home_page": null,
"name": "labbdocs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "django, ui, components, library, perfect, django-cotton, tailwind, daisyui",
"author": "zadiq",
"author_email": "dev@zadiq.com",
"download_url": "https://files.pythonhosted.org/packages/74/3d/b5b895dc4b3649cc55f078ae31447c23b318c5283d4154bacbaa6680d565/labbdocs-0.0.1a0.tar.gz",
"platform": null,
"description": "# labbdocs\n\nThe documentation is available online at [https://labb.io/docs](https://labb.io/docs).\n\nThis documentation is installed as a django app in the django project that powers the [labb.io](https://labb.io) website.\n\n## Installation\n\n```bash\npip install labbdocs\n```\n\n## Integration with a django site\n\n### 1. Add to INSTALLED_APPS\n\nAdd `labbdocs` to your Django project's `INSTALLED_APPS`:\n\n```python\n# settings.py\nINSTALLED_APPS = [\n # ... other apps\n 'labbdocs',\n]\n```\n\n### 2. Configure LABB_DOCS\n\nSet up your documentation configuration in your Django settings:\n\n```python\n# settings.py\nLABB_DOCS = {\n \"ui\": {\n \"config\": \"/path/to/your/ui.yaml\",\n \"title\": \"UI Components\",\n \"name\": \"ui\",\n \"url_prefix\": \"/docs/ui\",\n \"template_dir\": \"labbdocs/docs/ui/\",\n \"build_path\": \"/path/to/templates/build/docs/ui\"\n },\n \"icons\": {\n \"config\": \"/path/to/your/icons.yaml\",\n \"title\": \"Icon Library\",\n \"name\": \"icons\",\n \"url_prefix\": \"/docs/icons\",\n \"template_dir\": \"labbdocs/docs/icons/\",\n \"build_path\": \"/path/to/templates/build/docs/icons\"\n }\n}\n```\n\n### 3. Include URLs\n\nAdd labbdocs URLs to your main URL configuration:\n\n```python\n# urls.py\nfrom django.urls import path, include\n\nurlpatterns = [\n # ... other patterns\n path(\"\", include(\"labbdocs.urls\")),\n]\n```\n\n### 4. Build Documentation\n\nUse the management command to build your documentation:\n\n```bash\n# Build all documentation\npython manage.py build_docs ui\npython manage.py build_docs icons\n\n# Or build with quiet output\npython manage.py build_docs ui --quiet\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Documentation for the labb project",
"version": "0.0.1a0",
"project_urls": {
"Discussions": "https://github.com/labbhq/labb/discussions",
"Documentation": "https://labb.io/docs",
"Source": "https://github.com/labbhq/labb/tree/main/docs"
},
"split_keywords": [
"django",
" ui",
" components",
" library",
" perfect",
" django-cotton",
" tailwind",
" daisyui"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2bf839f1b4ead81b8bc83abdce20621b56b0d9d3a30511f55644f8c528a78780",
"md5": "28e0f007eadba23d9d73177bb6e9b43d",
"sha256": "2a86337e937e3ac34523f3e3dc5a20eccb4c68fef647752853298142fc766203"
},
"downloads": -1,
"filename": "labbdocs-0.0.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28e0f007eadba23d9d73177bb6e9b43d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 220073,
"upload_time": "2025-10-26T16:06:06",
"upload_time_iso_8601": "2025-10-26T16:06:06.122097Z",
"url": "https://files.pythonhosted.org/packages/2b/f8/39f1b4ead81b8bc83abdce20621b56b0d9d3a30511f55644f8c528a78780/labbdocs-0.0.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "743db5b895dc4b3649cc55f078ae31447c23b318c5283d4154bacbaa6680d565",
"md5": "c38c7eeb1f132386a9ee82abbc7cafb3",
"sha256": "11dc339433e35581de0c416437bb28e8fb17804cca741a13e702a9232babcfd9"
},
"downloads": -1,
"filename": "labbdocs-0.0.1a0.tar.gz",
"has_sig": false,
"md5_digest": "c38c7eeb1f132386a9ee82abbc7cafb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 194583,
"upload_time": "2025-10-26T16:06:07",
"upload_time_iso_8601": "2025-10-26T16:06:07.536744Z",
"url": "https://files.pythonhosted.org/packages/74/3d/b5b895dc4b3649cc55f078ae31447c23b318c5283d4154bacbaa6680d565/labbdocs-0.0.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-26 16:06:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "labbhq",
"github_project": "labb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "labbdocs"
}
JSON
