Flask extension to integrate discourse content generated to docs to your website.
Project description
# 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
discourse_api = DiscourseAPI(
base_url="https://forum.snapcraft.io/",
frontpage_id=3781, # The "Snap Documentation" topic
category_id=15, # The "doc" category
)
# From constructor
DiscourseDocs(
app=app,
model=discourse_api,
url_prefix="/",
document_template="document.html",
)
# or from init_app
discourse_docs = DiscourseDocs()
discourse_docs.init_app(
app=app,
model=discourse_api,
url_prefix="/",
document_template="document.html",
)
```
Once this is added you will need to add the file `document.html` to your template folder.
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
discourse_api = DiscourseAPI(
base_url="https://forum.snapcraft.io/",
frontpage_id=3781, # The "Snap Documentation" topic
category_id=15, # The "doc" category
)
# From constructor
DiscourseDocs(
app=app,
model=discourse_api,
url_prefix="/",
document_template="document.html",
)
# or from init_app
discourse_docs = DiscourseDocs()
discourse_docs.init_app(
app=app,
model=discourse_api,
url_prefix="/",
document_template="document.html",
)
```
Once this is added you will need to add the file `document.html` to your template folder.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for canonicalwebteam.discourse_docs-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c25ece26ef0c9608870aedffeac95c2abeb7ed74c450ec3835f1c3a0456ff4a5 |
|
MD5 | dfdcb25c809db988f91632e641061ef8 |
|
BLAKE2b-256 | 3a0fef6da373d55830d5e7a1d3153003847877e8107edcf98fc0c892ce32ad11 |
Close
Hashes for canonicalwebteam.discourse_docs-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b13ce1a080fe78494d344560ea98ef312490d6cc5944b68bbcddfb56c6a1871 |
|
MD5 | 582f951b259534a23483f5aedb9cffd9 |
|
BLAKE2b-256 | 6494f8005495da8cb901e12fd1f602710dd3336bec2d7a9c1c359569c6e5a012 |