Skip to main content

Sphinx "rawfiles" extension

Project description

rawfiles extension README

Copy raw files, like a CNAME.

Setting

You can get archive file at http://bitbucket.org/birkenfeld/sphinx-contrib/

Install

> easy_install sphinxcontrib-rawfiles

Configure Sphinx

To enable this extension, add sphinxcontrib.rawfiles module to extensions option at conf.py and add .

import os, sys

# Path to the folder where rawfiles.py is
# NOTE: not needed if the package is installed in traditional way
# using setup.py or easy_install
sys.path.append(os.path.abspath('/path/to/sphinxcontrib.rawfiles'))

# Enabled extensions
extensions = ['sphinxcontrib.rawfiles']

# Files you want to copy
rawfiles = ['CNAME']

Repository

This code is hosted by Bitbucket.

http://bitbucket.org/birkenfeld/sphinx-contrib/

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page