Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olivierverdier/sphinx-scons
Clone
https://github.com/olivierverdier/sphinx-scons
Last synced: about 6 hours ago
JSON representation
Clone
- Host: GitHub
- URL: https://github.com/olivierverdier/sphinx-scons
- Owner: olivierverdier
- Created: 2011-08-26T15:36:01.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2011-08-26T15:36:47.000Z (about 13 years ago)
- Last Synced: 2023-03-10T23:27:50.291Z (over 1 year ago)
- Language: Python
- Homepage: https://bitbucket.org/zondo/sphinx-scons/
- Size: 148 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
.. README file for sphinx-scons, in -*- rst -*- mode.
Introduction
============This package contains :file:`SConstruct`, a generic SCons_ build script for
invoking Sphinx_ to build documentation.The :program:`sphinx-quickstart` program can automatically create two build
scripts: a :file:`Makefile` for Unix systems, and a :file:`make.bat`
equivalent for Windows. This script has the advantage that it works the
same way on both systems (once you have installed SCons).Usage
=====Basically, just copy the :file:`SConstruct` file to the top-level directory
of your Sphinx docs, and then use :program:`scons` at a command prompt to
build things. Typing :command:`scons -h` will give a help message
describing all the things you can do.As an example, if you just type :command:`scons` in this package's
directory, you can read this :file:`README` in style, á la Sphinx.Bugs
====Report any problems to me at [email protected].
.. _SCons: http://www.scons.org
.. _Sphinx: http://sphinx.pocoo.org