django-w-docs 0.1.1

A reusable documentation app powered by Python, Django, DRF and Wagtail CMS.

django-w-docs

Overview

A reusable documentation app powered by Python, Django, DRF and Wagtail CMS.

Get started

Install the package:

pip install django-w-docs

Configure your Django settings:

# project/settings.py

# Application definition
INSTALLED_APPS = [
    "docs",
    "docs.api",  # Optional if you do not want to use the API
    "docs.apps.home",
    "docs.apps.indexes",
    "docs.apps.pages",
    "docs.apps.sections",
    "docs.apps.tags",
    "docs.cms",
    "docs.ui",
    # Deps
    "rest_wind",  # Optional if you do not want to use the API
    "rest_framework",  # Optional if you do not want to use the API
    "wagtail.contrib.search_promotions",
    "wagtail.contrib.forms",
    "wagtail.contrib.redirects",
    "wagtail.embeds",
    "wagtail.sites",
    "wagtail.users",
    "wagtail.snippets",
    "wagtail.documents",
    "wagtail.images",
    "wagtail.search",
    "wagtail.admin",
    "wagtail",
    "modelcluster",
    "taggit",
    ...
]

Run the migrations:

# In your project root
python mange.py migrate

Update your URLConf:

# project/urls.py

from django.urls import include, path


urlpatterns = [
    path("", include("docs.ui.urls")),
    path("api/", include("docs.api.urls")),  # Optional if you do not want to use the API
    path("api/", include("rest_framework.urls")),  # Optional if you do not want to use the API
    ...
    path("documents/", include(wagtaildocs_urls)),
    path("dashboard/", include(wagtailadmin_urls)),
    path("", include(wagtail_urls)),  # Make sure this line is the last
]

Key Features

• CI/CD Pipelines: Automated using GitHub Actions to ensure consistent and reliable deployment processes.
• Dependency Management: Powered by Poetry, a sophisticated tool for managing project dependencies with precision and reliability.
• Code Formatting: Automatically formatted with Black to maintain a consistent and readable codebase.
• Code Linting: Utilizes Ruff to identify and address potential issues early, enhancing code quality and maintainability.
• Code Testing: Utilizes Django to run tests.
• Configuration Files: Includes .gitignore, pyproject.toml, and other essential configuration files to streamline setup.

Contributing

We warmly welcome contributions from the community. Please refer to our CONTRIBUTING guide for detailed instructions on how to contribute effectively. Your feedback and participation are essential for the continued improvement of this template.

Support

For inquiries or support, please open an issue or join the discussion in the GitHub Discussions section to engage with the community.

Licensing

This project is licensed under the MIT License. A detailed copy of the terms can be found in the LICENSE file.