README.md

Pinax Wiki

Table of Contents

• About Pinax
• Important Links
• Overview
  • Supported Django and Python Versions
• Documentation
  • Installation
• Change Log
• Contribute
• Code of Conduct
• Connect with Pinax
• License

About Pinax

Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.

Important Links

Where you can find what you need:

• Releases: published to PyPI or tagged in app repos in the Pinax GitHub organization
• Global documentation: Pinax documentation website
• App specific documentation: app repos in the Pinax GitHub organization
• Support information: SUPPORT.md file in the Pinax default community health file repo
• Contributing information: CONTRIBUTING.md file in the Pinax default community health file repo
• Current and historical release docs: Pinax Wiki

pinax-wiki

Overview

pinax-wiki lets you easily add a wiki to your Django site.

Supported Django and Python Versions

Django / Python	3.6	3.7	3.8
2.2	*	*	*
3.0	*	*	*

Documentation

Installation

To install pinax-wiki:

    $ pip install pinax-wiki

Add pinax.wiki to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        # other apps
        "pinax.wiki",
    ]

Add pinax.wiki.urls to your project urlpatterns:

    urlpatterns = [
        # other urls
        url(r"^wiki/", include("pinax.wiki.urls", namespace="pinax_wiki")),
    ]

Change Log

2.0.0

• Drop Django 1.11, 2.0, and 2.1, and Python 2,7, 3.4, and 3.5 support
• Add Django 2.2 and 3.0, and Python 3.6, 3.7, and 3.8 support
• Update packaging configs
• Direct users to community resources

1.0.2

• Update templatetag decorator to simple_tag
• Fix MediaFile.download_url method

1.0.1

• Fix binders URLs

1.0.0

• Add Django 2.0 support.
• Drop Django 1.8, 1.9, 1.10 and Python 3.3 support
• Move documentation into README and standardize layout
• Convert CI and coverage to CircleCi and CodeCov
• Add PyPi-compatible long description
• Remove doc build support

Contribute

Contributing information can be found in the Pinax community health file repo.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a Code of Conduct. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.

Connect with Pinax

For updates and news regarding the Pinax Project, please follow us on Twitter @pinaxproject and check out our Pinax Project blog.

License

Copyright (c) 2012-present James Tauber and contributors under the MIT license.