https://github.com/dusktreader/sphinx-view

View your rendered Sphinx or ReStrucutredText documents in a browswer
https://github.com/dusktreader/sphinx-view

Last synced: about 1 year ago
JSON representation

View your rendered Sphinx or ReStrucutredText documents in a browswer

• Host: GitHub
• URL: https://github.com/dusktreader/sphinx-view
• Owner: dusktreader
• License: mit
• Created: 2016-12-09T01:19:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-30T17:49:21.000Z (over 4 years ago)
• Last Synced: 2025-04-04T14:05:05.717Z (about 1 year ago)
• Language: Python
• Homepage: http://sphinx-view.readthedocs.io/en/latest/
• Size: 76.2 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

          
.. image::  https://badge.fury.io/py/sphinx-view.svg

   :target: https://badge.fury.io/py/sphinx-view

   :alt:    Latest Published Version

.. image::  https://travis-ci.org/dusktreader/py-buzz.svg?branch=integration

   :target: https://travis-ci.org/dusktreader/py-buzz

   :alt:    Build Status

.. image::  https://readthedocs.org/projects/sphinx-view/badge/?version=latest

   :target: http://sphinx-view.readthedocs.io/en/latest/?badge=latest

   :alt:    Documentation Build Status

*************

 sphinx-view

*************

---------------------------------------------------------------------

View your rendered Sphinx or ReStrucutredText documents in a browser

---------------------------------------------------------------------

If you've ever done much work with Sphinx (or any ReStructuredText) documents,

you know how important it is to regularly check how they look when rendered

into html. Often, you get your formatting wrong or introduce a syntax error.

Constantly running sphinx-build by hand is really annoying.

There is a very nice tool called

`restview `_ that can be used to view

ReStructuredText files, but it doesn't support all the sphinx keywords and

features. Furthermore, it doesn't render with a style

The sphinx-view application automatically renders the documents using the

'alabaster' theme. It renders them using Sphinx itself. It is even capable of

rendering an entire directory at once and producing a full html page with

navigation between sub-pages. This is very handy if, for instance, you are

editing the ``docs`` folder of a python project.

In addition, sphinx-view will watch for changes to the documents, rebuild the

pages, and refresh the browser any time you save the documents you are viewing.

Super-quick Start

-----------------

 - requirements: `python3.4` or greater

 - install through pip: `$ pip install sphinx-view`

 - view a document: `$ sphinx-view README.rst`

Full Documentation

------------------

 - `spinx-view documentation home `_

 - `raw reStructuredText docs

   `_