Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

NtDocutils is a Material Design Lite theme for Docutils.

Project Description

NtDocutils is a Material Design Lite theme for Docutils. See the official site for more info.

Features

  • All features from Docutils for the rst2html5.py writer.
  • Special roles for emojis and keyboard keys.
  • Filter content by OS and distributions.
  • Download the attachments, print the article and more.
  • Theme customization.

Installation

If you will install NtDocutils without a virtualenv on Debian (or other GNU/Linux distribution), you will need superuser privileges.

NtDocutils requires:

From PyPI

pip install NtDocutils==0.1.0

Usage

Basically, you have to do two things:

  1. Create a .rst file:

    example.rst:

     1 ==========
     2 My Article
     3 ==========
     4 
     5 :Author: Vultur Gryphus
     6 :Contact: info@vultur.org.ve
     7 
     8 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
     9 eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
    10 minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
    11 ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
    12 voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur
    13 sint occaecat cupidatat non proident, sunt in culpa qui officia
    14 deserunt mollit anim id est laborum.
    
  2. Process your file:

    ntdocutils example.rst example.html
    

And that’s it, you already have some like this:

See this section in the official site for more utilites.

Command line reference

ntdocutils [-h] [-V] [-S SERVER] SOURCE DESTINATION
-h, --help Shows the help message.
-V, --version Shows the NtDocutils version.
-S SERVER, --server SERVER
 Server where assets are hosted. If file is passed as value, it will activate the offline mode, this will create a directory with the theme name in the DESTINATION parent folder and stores the necessary assets in there.
All the options from the rst2html.py writer are available.

Uninstallation

If you did install NtDocutils without a virtualenv on Debian (or other GNU/Linux distribution), you will need superuser privileges.

Should be enough with this:

pip uninstall NtDocutils

Attributions and references

NtDocutils uses:

Docutils Team. reStructuredText. http://docutils.sourceforge.net/rst.html

Mozilla Developer Network. JavaScript | MDN. https://developer.mozilla.org/en-US/docs/Web/JavaScript

Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
NtDocutils-0.1.0-2-py3-none-any.whl (419.0 kB) Copy SHA256 Checksum SHA256 py3 Wheel Apr 7, 2017
NtDocutils-0.1.0-2.tar.gz (409.3 kB) Copy SHA256 Checksum SHA256 Source Apr 7, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting