Code Monkey home page Code Monkey logo

restview's Introduction

restview

buildstatus appveyor coverage

A viewer for ReStructuredText documents that renders them on the fly.

Pass the name of a ReStructuredText document to restview, and it will launch a web server on localhost:random-port and open a web browser. Every time you reload the page, restview will reload the document from disk and render it. This is very convenient for previewing a document while you're editing it.

You can also pass the name of a directory, and restview will recursively look for files that end in .txt or .rst and present you with a list.

Finally, you can make sure your Python package has valid ReStructuredText in the long_description field by using

restview --long-description

Synopsis

Usage: restview [options] filename-or-directory [...]

-h, --help show this help message and exit
-l PORT, --listen=PORT
 listen on a given port (or interface:port, e.g. *:8080) [default: random port on localhost]
-b, --browser open a web browser [default: only if -l was not specified]
-e COMMAND, --execute=COMMAND
 run a command to produce ReStructuredText
-w FILENAME, --watch=FILENAME
 reload the page when a file changes (use with --execute); can be specified multiple times
--long-description
 run "python setup.py --long-description" to produce ReStructuredText; also enables --pypi-strict and watches the usual long description sources (setup.py, README.rst, CHANGES.rst)
--css=URL-or-FILENAME
 use the specified stylesheet; can be specified multiple times [default: html4css1.css,restview.css]
--strict halt at the slightest problem
--pypi-strict enable additional restrictions that PyPI performs

Installation

On .deb based systems (e.g. Ubuntu)

sudo apt-get install python-pip
sudo pip install restview

On .rpm based systems (e.g. Fedora)

su
yum install python-pip
pip install restview

restview's People

Contributors

mgedmin avatar ericfromcanada avatar myint avatar rsyring avatar gkotian avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.