Metadata-Version: 2.1
Name: canonicalwebteam.discourse-docs
Version: 0.6.5
Summary: Flask extension to integrate discourse content generated to docs to your website.
Home-page: https://github.com/canonical-webteam/canonicalwebteam.docs
Author: Canonical webteam
Author-email: webteam@canonical.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: Flask (>=1.0.2)
Requires-Dist: canonicalwebteam.http
Requires-Dist: beautifulsoup4
Requires-Dist: humanize
Requires-Dist: python-dateutil
Requires-Dist: validators

# canonicalwebteam.discourse_docs

Flask extension to integrate discourse content generated to docs to your website.

## Install

Install the project with pip: `pip install canonicalwebteam.discourse_docs`

You can add the extension on your project:

```
from canonicalwebteam.discourse_docs import DiscourseDocs, DiscourseAPI

app = Flask("myapp")

DISCOURSE_BASE_URL = "https://forum.example.com/"
DOCS_INDEX_TOPIC = 321
DOCS_CATEGORY_ID = 21
DOCS_URL_PREFIX = '/docs'
DOCS_TEMPLATE_PATH = "docs/document.html"

DiscourseDocs(
    api=DiscourseAPI(base_url=DISCOURSE_BASE_URL),
    index_topic_id=DOCS_INDEX_TOPIC,
    category_id=DOCS_CATEGORY_ID,
    document_template=DOCS_TEMPLATE_PATH,  # Optional
    url_prefix=DOCS_URL_PREFIX,  # Optional
).init_app(app)
```

Once this is added you will need to add the file `document.html` to your template folder.


