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 as follows, replacing, at least, base_url and index_topic_id with your own settings:
import talisker.requests
from canonicalwebteam.discourse_docs import DiscourseDocs, DiscourseAPI
app = Flask("myapp")
session = talisker.requests.get_session()
discourse_docs = DiscourseDocs(
parser=DocParser(
api=DiscourseAPI(
base_url="https://forum.example.com/", session=session
),
index_topic_id=321,
url_prefix="/docs",
),
document_template="docs/document.html",
url_prefix="/docs",
)
discourse_docs.init_app(app)
Once this is added you will need to add the file document.html to your template folder.
4 maintainers
Metadata
4 maintainers
Release files for canonicalwebteam.discourse-docs 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| canonicalwebteam.discourse_docs-1.0.1.tar.gz | 13.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| canonicalwebteam.discourse_docs-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.2 kB
Release files / canonicalwebteam.discourse_docs-1.0.1.tar.gz
| Download URL | canonicalwebteam.discourse_docs-1.0.1.tar.gz |
|---|---|
| Size | 13.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6a40ed76cb829252ba6d1b5b881f20d7344d12b9546b375597c018d16f549fd
|
|
BLAKE2b-256 checksum How to use checksums |
74cc3da168c2a538af812ef67c546cb7ee6e9e2b585cd46d7c1465288a205019
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.8
|
Release files / canonicalwebteam.discourse_docs-1.0.1-py3-none-any.whl
| Download URL | canonicalwebteam.discourse_docs-1.0.1-py3-none-any.whl |
|---|---|
| Size | 18.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
618fb6f7bdd2002b5dd73d54ab4e7c063e12af27b87abe48efd0fe34f74ef685
|
|
BLAKE2b-256 checksum How to use checksums |
3479b52fe100ffa5e0fe56d844d973b648d4bff51b5b98978e4429070a7ba732
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.8
|
