Documentation Utilities (Docutils, reStructuredText) for django.)
Project description
django-docutils · 
django-docutils, docutils (reStructuredText) support for Django
Quickstart
Install django-docutils:
$ pip install django-docutils
Template filter
If you want to use the template filter, add it to your INSTALLED_APPS in your settings file:
INSTALLED_APPS = [ # ... your default apps,
'django_docutils'
]
Then in your template:
{% load django_docutils %}
{% filter restructuredtext %}
# hey
# how's it going
A. hows
B. it
C. going
D. today
**hi**
*hi*
{% endfilter %}
Template engine (class-based view)
You can also use a class-based view to render restructuredtext.
If you want to use reStructuredText as a django template engine, INSTALLED_APPS isn't required,
instead you add this to your TEMPLATES variable in your settings:
TEMPLATES = [ # .. your default engines
{
'NAME': 'docutils',
'BACKEND': 'django_docutils.engines.Docutils',
'DIRS': [],
'APP_DIRS': True,
}]
Now django will be able to scan for .rst files and process them. In your view:
from django_docutils.views import DocutilsView
class HomeView(DocutilsView):
template_name = 'base.html'
rst_name = 'home.rst'
Settings
BASED_LIB_RST = { # Optional, automatically maps roles, directives and transformers
'docutils': {
'raw_enabled': True,
'strip_comments': True,
'initial_header_level': 2,
},
'roles': {
'local': {
'gh': 'django_docutils.lib.roles.github.github_role',
'twitter': 'django_docutils.lib.roles.twitter.twitter_role',
'email': 'django_docutils.lib.roles.email.email_role',
}
},
'font_awesome': { # Transformer to inject <em class="<class>"></em>
'url_patterns': {
r'.*github.com.*': 'fab fa-github',
r'.*twitter.com.*': 'fab fa-twitter',
r'.*amzn.to.*': 'fab fa-amazon',
r'.*amazon.com.*': 'fab fa-amazon',
r'.*news.ycombinator.com*': 'fab fa-hacker-news',
r'.*leanpub.com.*': 'fab fa-leanpub',
r'.*python.org.*': 'fab fa-python',
r'.*pypi.org.*': 'fab fa-python',
r'.*djangoproject.com.*': 'fab fa-python',
r'.*wikipedia.org.*': 'fab fa-wikipedia',
r'((rtfd|readthedocs).)*$': 'fab fa-books',
r'^mailto:.*': 'fas fa-envelope',
r'((?!mywebsite.com|localhost).)*$': 'fas fa-external-link',
}
},
}
BASED_LIB_TEXT = { # Optional
'uncapitalized_word_filters': ['project.my_module.my_capitalization_fn']
}
BASED_ADS = { # If injecting ads
'AMAZON_AD_CODE': """
<script type="text/javascript">
amzn_assoc_placement = "adunit0";
amzn_assoc_search_bar = "true";
amzn_assoc_tracking_id = "mytracking-20";
amzn_assoc_search_bar_position = "bottom";
amzn_assoc_ad_mode = "search";
amzn_assoc_ad_type = "smart";
amzn_assoc_marketplace = "amazon";
amzn_assoc_region = "US";
amzn_assoc_title = "You may be interested in";
amzn_assoc_default_search_phrase = "{keyword}";
amzn_assoc_default_category = "All";
amzn_assoc_linkid = "6efef5538142e4a4031b04de66b6e804";
</script>
<script src="//z-na.amazon-adsystem.com/widgets/onejs?MarketPlace=US"></script>
""",
'AMAZON_AD_STRIP': (
'<script src="//z-na.amazon-adsystem.com/widgets/onejs?MarketPlace=US&'
'adInstanceId=521gc14d-d9f1-4691-8af2-a38de0d0cbad"></script>'
),
'GOOGLE_AD_CODE': """
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js">
</script>
<ins class="adsbygoogle"
style="display:block; text-align:center;"
data-ad-layout="in-article"
data-ad-format="fluid"
data-ad-client="ca-pub-5555555555555555"
data-ad-slot="5555555555"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
""",
}
More information
- Python 3.8+
- Django 3.1+
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
File details
Details for the file django_docutils-0.11.0.post0.tar.gz.
File metadata
- Download URL: django_docutils-0.11.0.post0.tar.gz
- Upload date:
- Size: 68.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 46e68d508356b9fff7ed7d649bd1aded0c9bd175a0c5ebe1d8af5c72aafb177f |
|
| MD5 | 4fd5a68014bb307e96ac9a2426e72dfb |
|
| BLAKE2b-256 | e13bc9046e7bd26b971f9417572fb2922f7bbe6cd23433be50633e7530845524 |
Provenance
File details
Details for the file django_docutils-0.11.0.post0-py3-none-any.whl.
File metadata
- Download URL: django_docutils-0.11.0.post0-py3-none-any.whl
- Upload date:
- Size: 100.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ef91c27a139ff3ab8dcc02a8839c654e17557535a89d343318acb1cf390e082f |
|
| MD5 | 8f1797e80ec4af632e55583db843cd03 |
|
| BLAKE2b-256 | a5b4d1760f0f1cc0113bccb596e95f04f0b8642be6f5939b8286bf0d3524135b |
