Documentation Utilities (Docutils, reStructuredText) for django.)
Project description
django-docutils, docutils (reStructuredText) support for Django
Documentation
The full documentation is at https://django-docutils.git-pull.com.
Quickstart
Install django-docutils:
pip install django-docutils # if fetching favicons pip install django-docutils[favicon] # intersphinx support pip install django-docutils[intersphinx] # both pip install django-docutils[favicon,intersphinx]
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> """, }
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size django_docutils-0.5.1-py3-none-any.whl (99.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size django-docutils-0.5.1.tar.gz (68.2 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for django_docutils-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d169d1ee16633b6ce8eaa6708d72ec9109c7959b8170e316e53890f075763624 |
|
MD5 | 8aa22ed4febae20b452048b685b36c60 |
|
BLAKE2-256 | a8d7a316a20f6bf7b6eec8bec941bb758844b448f277552a9d2707641d822051 |