mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Don't install scripts twice. Thanks to lunar.
This commit is contained in:
parent
5dfd70d04d
commit
5a131c30a2
4
README
4
README
@ -17,8 +17,8 @@ Reading the docs
|
||||
After installing::
|
||||
|
||||
cd doc
|
||||
sphinx-build.py . .build
|
||||
browser .build/index.html
|
||||
sphinx-build . _build/html
|
||||
browser _build/index.html
|
||||
|
||||
Or read them online at <http://sphinx.pocoo.org/>.
|
||||
|
||||
|
@ -10,7 +10,7 @@ These are the built-in Sphinx builders. More builders can be added by
|
||||
:ref:`extensions <extensions>`.
|
||||
|
||||
The builder's "name" must be given to the **-b** command-line option of
|
||||
:program:`sphinx-build.py` to select a builder.
|
||||
:program:`sphinx-build` to select a builder.
|
||||
|
||||
|
||||
.. class:: StandaloneHTMLBuilder
|
||||
|
@ -31,11 +31,11 @@ The root directory of a documentation collection is called the
|
||||
:dfn:`documentation root`. There's nothing special about it; it just needs to
|
||||
contain the Sphinx configuration file, :file:`conf.py`.
|
||||
|
||||
Sphinx comes with a script called :program:`sphinx-quickstart.py` that sets up a
|
||||
Sphinx comes with a script called :program:`sphinx-quickstart` that sets up a
|
||||
documentation root and creates a default :file:`conf.py` from a few questions
|
||||
it asks you. Just run ::
|
||||
|
||||
$ sphinx-quickstart.py
|
||||
$ sphinx-quickstart
|
||||
|
||||
and answer the questions.
|
||||
|
||||
@ -43,17 +43,17 @@ and answer the questions.
|
||||
Running a build
|
||||
---------------
|
||||
|
||||
A build is started with the :program:`sphinx-build.py` script. It is called
|
||||
A build is started with the :program:`sphinx-build` script. It is called
|
||||
like this::
|
||||
|
||||
$ sphinx-build.py -b latex sourcedir builddir
|
||||
$ sphinx-build -b latex sourcedir builddir
|
||||
|
||||
where *sourcedir* is the :term:`documentation root`, and *builddir* is the
|
||||
directory in which you want to place the built documentation (it must be an
|
||||
existing directory). The :option:`-b` option selects a builder; in this example
|
||||
Sphinx will build LaTeX files.
|
||||
|
||||
The :program:`sphinx-build.py` script has several more options:
|
||||
The :program:`sphinx-build` script has several more options:
|
||||
|
||||
**-a**
|
||||
If given, always write all output files. The default is to only write output
|
||||
|
3
setup.py
3
setup.py
@ -57,7 +57,8 @@ setup(
|
||||
platforms='any',
|
||||
packages=['sphinx'],
|
||||
include_package_data=True,
|
||||
scripts=['sphinx-build.py', 'sphinx-web.py', 'sphinx-quickstart.py'],
|
||||
# replaced by the entry points
|
||||
#scripts=['sphinx-build.py', 'sphinx-web.py', 'sphinx-quickstart.py'],
|
||||
entry_points={
|
||||
'console_scripts': [
|
||||
'sphinx-build = sphinx:main',
|
||||
|
@ -19,7 +19,7 @@ QUICKSTART_CONF = '''\
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# %(project)s documentation build configuration file, created by
|
||||
# sphinx-quickstart.py on %(now)s.
|
||||
# sphinx-quickstart on %(now)s.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
@ -151,7 +151,7 @@ htmlhelp_basename = '%(project)sdoc'
|
||||
'''
|
||||
|
||||
MASTER_FILE = '''\
|
||||
.. %(project)s documentation master file, created by sphinx-quickstart.py on %(now)s.
|
||||
.. %(project)s documentation master file, created by sphinx-quickstart on %(now)s.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
@ -178,7 +178,7 @@ MAKEFILE = '''\
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build.py
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
|
||||
ALLSPHINXOPTS = -d %(rbuilddir)s/doctrees -D latex_paper_size=$(PAPER) \\
|
||||
@ -342,7 +342,7 @@ document is a custom template, you can also set this to another filename.'''
|
||||
'index')
|
||||
print '''
|
||||
If you are under Unix, a Makefile can be generated for you so that you
|
||||
only have to run e.g. `make html' instead of invoking sphinx-build.py
|
||||
only have to run e.g. `make html' instead of invoking sphinx-build
|
||||
directly.'''
|
||||
do_prompt(d, 'makefile', 'Create Makefile? (y/n)',
|
||||
os.name == 'posix' and 'y' or 'n', boolean)
|
||||
@ -387,11 +387,11 @@ directly.'''
|
||||
print bold('Finished: An initial directory structure has been created.')
|
||||
print '''
|
||||
You should now populate your master file %s and create other documentation
|
||||
source files. Use the sphinx-build.py script to build the docs, like so:
|
||||
source files. Use the sphinx-build script to build the docs, like so:
|
||||
''' % masterfile + (create_makefile and '''
|
||||
make <builder>
|
||||
''' or '''
|
||||
sphinx-build.py -b <builder> %s %s
|
||||
sphinx-build -b <builder> %s %s
|
||||
''' % (srcdir, builddir))
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user