Quickstart

Requirements

• Python 3.5

Note on Requirements

There are not currently plans to support python 2. Since this is a stand-alone application, it is not as important to support multiple versions of python. Additionally, the original author is a proponent of python 3 adoption.

There are plans to support other versions of python 3, but the priority is a bit lower than a lot of other projects the author has going now

Installation

Install from pypi

This will install the latest release of flask-praetorian from pypi via pip:

$ pip install sphinx-view

Install latest version from github

If you would like a version other than the latest published on pypi, you may do so by cloning the git repostiory:

$ git clone https://github.com/dusktreader/sphinx-view.git

Next, checkout the branch or tag that you wish to use:

$ cd sphinx-view
$ git checkout integration

Finally, use pip to install from the local directory:

$ pip install .

Note

sphinx-view does not support distutils or setuptools. pip is a really complete package manager and has become the de-facto standard for installing python packages from remote locations. Compatability with pip is of primary importance, and since pip is such a great tool, it makes the most sense to the original author to use pip for local installs as well.

View a single document

Just execute sphinx-view targeting the file you wish to view in a browser:

$ sphinx-view README.rst

A new page will open in your browser showing the html rendered document.

sphinx-view will automatically refresh the browser if you make any changes to the document, so you can view the file as you edit it.

View a directory

This feature is most useful for looking at the rendered version of a set of interrelated docs in a directory. Simply target the directory with spinx-view and everything should just work:

$ sphinx-view docs

For a directory, sphinx-view will watch for changes to any of the files and update the browser with new changes

View a package

This feature is most useful for looking at the rendered version of docs for a python package. Simply target the directory of the package with spinx-view, supply the --package argument, and everything should just work:

$ sphinx-view --package /home/dusktreader/work/sphinx-view

For a package build, sphinx-view will watch for changes to any of the files and update the browser with new changes

Using a custom config file

You can try to use sphinx-view with your own sphinx config file:

$ sphinx-view --config conf.py docs

However, it should be noted that many settings will not work if you have not installed dependencies and any additional features that you activate have not been tested. So, there are no guarantees that sphinx-view will work as intended with custom config files