Download Shareware and Freeware Software for Windows, Linux, Macintosh, PDA

line Home  |  About Us  |  Link To Us  |  FAQ  |  Contact

Serving Software Downloads in 976 Categories, Downloaded 29.635.499 Times

sphinxcontrib-paverutils 1.3

Company: Doug Hellmann
Date Added: July 20, 2013  |  Visits: 185

sphinxcontrib-paverutils

Report Broken Link
Printer Friendly Version


Product Homepage
Download (16 downloads)



sphinxcontrib-paverutils is a Python module that provides an alternative integration of Sphinx and Paver. It supports calling Sphinx from within Paver using multiple configurations, and does not assume you only want to build HTML output.<br /><br />Basic Usage<br /><br />To use this module, import it in your pavement.py file as from sphinxcontrib import paverutils, then define option Bundles for "html" and/or "pdf" output using the options described in the task help.<br /><br />For example:<br /><br />import paver<br />import paver.misctasks<br />from paver.path import path<br />from paver.easy import *<br />import paver.setuputils<br />paver.setuputils.install_distutils_tasks()<br />try:<br /> from sphinxcontrib import paverutils<br />except:<br /> import warnings<br /> warnings.warn('sphinxcontrib.paverutils was not found, you will not be able to produce documentation')<br /><br />options(<br /> setup=Bunch(<br /> name = 'MyProject',<br /> version = '1.0',<br /><br /> # ... more options here ...<br /> ),<br /><br /> # Defaults for sphinxcontrib.paverutils<br /> sphinx = Bunch(<br /> docroot='.',<br /> sourcedir='docsource',<br /> builder='html',<br /> ),<br /><br /> # One configuration to build HTML for the package<br /> html=Bunch(<br /> builddir='docs',<br /> confdir='sphinx/pkg',<br /> ),<br /><br /> # Another configuration with different templates<br /> # to build HTML to upload to the website<br /> website=Bunch(<br /> builddir = 'web',<br /> confdir='sphinx/web',<br /> ),<br /><br /> # We also want a PDF file for the website,<br /> # so the instructions are included in the web<br /> # configuration directory.<br /> pdf=Bunch(<br /> builddir='web',<br /> builder='latex',<br /> confdir='sphinx/web',<br /> ),<br /><br />)<br /><br />Configuration Parameters<br /><br />docroot<br /><br /> the root under which Sphinx will be working.<br /><br /> default: docs<br /><br />builddir<br /><br /> directory under the docroot where the resulting files are put.<br /><br /> default: build<br /><br />sourcedir<br /><br /> directory under the docroot for the source files<br /><br /> default: (empty string)<br /><br />doctrees<br /><br /> the location of the cached doctrees<br /><br /> default: $builddir/doctrees<br /><br />confdir<br /><br /> the location of the sphinx conf.py<br /><br /> default: $sourcedir<br /><br />outdir<br /><br /> the location of the generated output files<br /><br /> default: $builddir/$builder<br /><br />builder<br /><br /> the name of the sphinx builder to use<br /><br /> default: html<br /><br />template_args<br /><br /> dictionary of values to be passed as name-value pairs to the HTML builder<br /><br /> default: {}<br /><br />Advanced Usage<br /><br />You can also develop your own tasks by calling run_sphinx() directly:<br /><br />@task<br />@needs(['cog'])<br />@cmdopts([<br /> ('in-file=', 'b', 'Blog input filename'),<br /> ('out-file=', 'B', 'Blog output filename'),<br />])<br />def blog(options):<br /> """Generate the blog post version of the HTML for the current module.<br /> """<br /> # Generate html from sphinx<br /> paverutils.run_sphinx(options, 'blog')<br /><br /> blog_file = path(options.blog.outdir) / options.blog.out_file<br /> dry("Write blog post body to %s" % blog_file,<br /> gen_blog_post,<br /> outdir=options.blog.outdir,<br /> input_base=options.blog.in_file,<br /> blog_base=options.blog.out_file,<br /> )<br /><br /> if 'EDITOR' in os.environ:<br /> sh('$EDITOR %s' % blog_file)<br /> return

Requirements: No special requirements
Platforms: *nix, Linux
Keyword: Blog Blog File Build Builder Configuration Default Directory Docroot Files Import Location Module Options Output Sphinx Sphinxcontrib Version Website
Users rating: 0/10

License: Freeware Size: 10.24 KB
USER REVIEWS
More Reviews or Write Review


SPHINXCONTRIB-PAVERUTILS RELATED
Libraries  -  File::Type::Builder 0.22
File::Type::Builder is Perl module to parse mime-magic and generate code. SYNOPSIS my $build = File::Type::Builder->new(); while ( ) { chomp; my $parsed = $build->parse_magic($_); my $code = $build->string_start($parsed); (or...
153.6 KB  
Libraries  -  File::Find 5.8.8
File::Find is a Perl module to traverse a directory tree. SYNOPSIS use File::Find; find(&wanted, @directories_to_search); sub wanted { ... } use File::Find; finddepth(&wanted, @directories_to_search); sub wanted { ... } use File::Find;...
12.2 MB  
Specialized Tools  -  File Identity Builder 2.0
File Identity Builder as a development tool that will allow you to create file identities from characters, or determine the identity by the number. Have you ever wondered what number compilers put into EXE files that give them that wonderful MZ...
305.17 KB  
FTP Clients  -  JFTP2 4.0
JFTP is a graphical FTP (File Transfer Protocol) client software for transferring files from one computer to another over TCP/IP networks such as Internet. JFTP allows you to connect to every ftp server, to transfer files between multiple...
36 MB  
Libraries  -  Java::SJ::Config 0.01
Java::SJ::Config is a Perl module that represents SJ Configuration File. It uses XML::XPath to parse configuration files and generates objects to represent the directives. Unless youre working on the module what you really want to know is what...
18.43 KB  
Networking  -  MeemiInWorpress 3.1
Meemi in Wordpress can: * Widget: Display your meme on sidebar of your blog * Meemi Post: Send your blog's post and updates to Meemi * Meemi Comment: Display post's comments (on Meemi) on post's page (require Meemi Post) * Meemi Content: Put meme...
10 KB  
Modules  -  Bye Maridjan 0.3
Optimizes your WordPress blog for Search Engines Install : 1. Upload Directory bye_maridjan to the /wp-content/plugins/ directory 2. Activate the plugin through the 'Plugins' menu in WordPress 3. A new menu will appear! Bye MaridjanPERFECT!
204.8 KB  
Libraries  -  File::Save::Home 0.08
File::Save::Home is a Perl module to place file safely under user home directory. SYNOPSIS use File::Save::Home qw( get_home_directory get_subhome_directory_status make_subhome_directory restore_subhome_directory_status...
18.43 KB  
Libraries  -  File::FindByRegex 1.2
File::FindByRegex is a Perl wrapper for File::Find that finds a directory tree and runs some action for each file whose name matchs a regex. SYNOPSYS use File::FindByRegex; $find = File::FindByRegex->new( { -srcdir => [C:tmpteradata-sql],...
10.24 KB  
Network & Internet  -  Htscanner 0.8.1
Htscanner will allow one to use htaccess-like file to configure PHP per directory, just like apaches htaccess. It is especially useful with fastcgi. This package was originally developed by Bart Vanbrabant. Old versions are available from:...
6.14 KB  
NEW DOWNLOADS IN LINUX SOFTWARE, PROGRAMMING
Linux Software  -  Polling Autodialer Software 3.4
ICTBroadcast Auto Dialer software has a survey campaign for telephone surveys and polls. This auto dialer software automatically dials a list of numbers and asks them a set of questions that they can respond to, by using their telephone keypad....
488 B  
Linux Software  -  Total Video Converter Mac Free 3.5.5
Total Video Converter Mac Free developed by EffectMatrix Ltd is the official legal version of Total Video Converter which was a globally recognized brand since 2006. Total Video Converter Mac Free is a free but powerful all-in-one video...
17.7 MB  
Linux Software  -  Skeith mod_log_sql Analyzer 2.10beta2
Skeith is a php based front end for analyzing logs for Apache using mod_log_sql.
47.5 KB  
Linux Software  -  SLAX 6.0+
Slax is a modern, portable, small and fast Linux operating system with a modular approach and outstanding design. Despite its small size, Slax provides a wide collection of pre-installed software for daily use, including a well organized graphical...
190 KB  
Linux Software  -  GTK+ 2.5
GTK+, which stands for the GIMP Toolkit, is a library for creating graphical user interfaces for the X Window System. It is designed to be small, efficient, and flexible. GTK+ is written in C with a very object-oriented approach. Language bindings...
60 MB  
Programming  -  FLEX-db Digital Asset Manager 3.0.9
FLEX-db - an enterprise Digital Asset Manager (DAM). It ingests and links metadata with files, creates thumbnails, and processes files using business rules. FLEX-db has a JSP client, Java app server for file input and output and an EJB metadata...
21.57 MB  
Programming  -  Libicom 0.9.0
The libicom library is a character based dynamicly linked library for Linux. It is used to remotely control the Icom IC-R8500 wide band receiver via an RS232 link. All call and return parameters to the control functions are character string based....
20.48 KB  
Programming  -  dotdesktop 0.3
Dotdesktop library provides ability to parse desktop entry file and access the information in a convenient way. Desktop entry file format is defined by freedesktop.org, it is used to describe information about an application such as the name and...
327.68 KB  
Programming  -  Cedalion for Linux 0.2.6
Cedalion is a programming language that allows its users to add new abstractions and define (and use) internal DSLs. Its innovation is in the fact that it uses projectional editing to allow the new abstractions to have no syntactic limitations.
471.04 KB  
Programming  -  libyasl 0.2
Libyasl is a C++ class library to easily realize TCP/UDP/Multicast clientsand servers in IPv4 and IPv6 environments under GNU/Linux systems.
143.36 KB