IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge in copyright style changes from 0.5.

Browse Source
This commit is contained in:
Georg Brandl 2009-01-03 12:15:19 +01:00
commit f16f94f2cd
61 changed files with 132 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
AUTHORS
View File

@ -1,8 +1,27 @@
The doctools are written and maintained by Georg Brandl <georg@python.org>.
Substantial parts of the templates and the web application were written by
Armin Ronacher <armin.ronacher@active-4.com>.
Sphinx is written and maintained by Georg Brandl <georg@python.org>.
Other contributors are noted in the :copyright: fields within the docstrings
of the respective files.
Substantial parts of the templates were written by Armin Ronacher
<armin.ronacher@active-4.com>.
Other contributors, listed alphabetically, are:
* Daniel Bültmann -- todo extension
* Josip Dzolonga -- coverage builder
* Horst Gutmann -- internationalization support
* Martin Hans -- autodoc improvements
* Dave Kuhlman -- original LaTeX writer
* Thomas Lamb -- linkcheck builder
* Benjamin Peterson -- unittests
* Antonio Valentino -- qthelp builder
* Pauli Virtanen -- autodoc improvements
* Sebastian Wiesner -- image handling, distutils support
Many thanks for all contributions!
There are also a few modules or functions incorporated from other
authors and projects:
* sphinx.util.jsdump uses the basestring encoding from simplejson,
written by Bob Ippolito, released under the MIT license
* sphinx.util.stemmer was written by Vivake Gupta, placed in the
Public Domain

50
LICENSE
View File

@ -1,17 +1,19 @@
Copyright (c) 2007-2008 by the respective authors (see AUTHORS file).
Copyright (c) 2007-2009 by the respective authors (see AUTHORS file).
All rights reserved.
License for Sphinx
==================
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@ -24,3 +26,37 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Licenses for incorporated software
==================================
The ElementTree package, included in this distribution in
test/etree13, is available under the following license:
----------------------------------------------------------------------
The ElementTree toolkit is
Copyright (c) 1999-2007 by Fredrik Lundh
By obtaining, using, and/or copying this software and/or its
associated documentation, you agree that you have read, understood,
and will comply with the following terms and conditions:
Permission to use, copy, modify, and distribute this software and its
associated documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appears in all
copies, and that both that copyright notice and this permission notice
appear in supporting documentation, and that the name of Secret Labs
AB or the author not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior
permission.
SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT- ABILITY
AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
----------------------------------------------------------------------

2
sphinx/__init__.py
View File

@ -5,7 +5,7 @@
The Sphinx documentation toolchain.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/_jinja.py
View File

@ -5,7 +5,7 @@
Jinja glue.
:copyright: 2007-2008 by Georg Brandl, Horst Gutmann.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/addnodes.py
View File

@ -5,7 +5,7 @@
Additional docutils nodes.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

3
sphinx/application.py
View File

@ -7,8 +7,7 @@
Gracefully adapted from the TextPress system by Armin.
:copyright: 2008 by Georg Brandl, Armin Ronacher.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builder.py
View File

@ -8,7 +8,7 @@
This module is only kept for API compatibility; new code should
import these classes directly from the sphinx.builders package.
:copyright: 2008-2009 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/changes.py
View File

@ -5,7 +5,7 @@
Changelog builder.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/html.py
View File

@ -5,7 +5,7 @@
Several HTML builders.
:copyright: 2007-2009 by Georg Brandl, Armin Ronacher.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/htmlhelp.py
View File

@ -6,7 +6,7 @@
Build HTML help support files.
Parts adapted from Python's Doc/tools/prechm.py.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/latex.py
View File

@ -5,7 +5,7 @@
LaTeX builder.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/linkcheck.py
View File

@ -5,7 +5,7 @@
The CheckExternalLinksBuilder class.
:copyright: 2008 by Georg Brandl, Thomas Lamb.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/qthelp.py
View File

@ -5,7 +5,7 @@
Build input files for the Qt collection generator.
:copyright: 2008 by Antonio Valentino.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/builders/text.py
View File

@ -5,7 +5,7 @@
Plain-text Sphinx builder.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/cmdline.py
View File

@ -5,7 +5,7 @@
sphinx-build command-line handling.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

4
sphinx/config.py
View File

@ -5,8 +5,8 @@
Build configuration file handling.
:copyright: 2008 by Georg Brandl.
:license: BSD, see LICENSE for details license.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os

2
sphinx/directives/__init__.py
View File

@ -5,7 +5,7 @@
Handlers for additional ReST directives.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/directives/code.py
View File

@ -3,7 +3,7 @@
sphinx.directives.code
~~~~~~~~~~~~~~~~~~~~~~
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/directives/desc.py
View File

@ -3,7 +3,7 @@
sphinx.directives.desc
~~~~~~~~~~~~~~~~~~~~~~
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/directives/other.py
View File

@ -3,7 +3,7 @@
sphinx.directives.other
~~~~~~~~~~~~~~~~~~~~~~~
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

4
sphinx/environment.py
View File

@ -5,7 +5,11 @@
Global creation environment.
<<<<<<< local
:copyright: 2007-2009 by Georg Brandl.
=======
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
>>>>>>> other
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/__init__.py
View File

@ -5,6 +5,6 @@
Contains Sphinx features not activated by default.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/autodoc.py
View File

@ -7,7 +7,7 @@
the doctree, thus avoiding duplication between docstrings and documentation
for those who like elaborate docstrings.
:copyright: 2008 by Georg Brandl, Pauli Virtanen, Martin Hans.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/coverage.py
View File

@ -6,7 +6,7 @@
Check Python modules and C API for coverage. Mostly written by Josip
Dzolonga for the Google Highly Open Participation contest.
:copyright: 2008 by Josip Dzolonga, Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/doctest.py
View File

@ -6,7 +6,7 @@
Mimic doctest by automatically executing code snippets and checking
their results.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/ifconfig.py
View File

@ -16,7 +16,7 @@
namespace of the project configuration (that is, all variables from ``conf.py``
are available.)
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/intersphinx.py
View File

@ -20,7 +20,7 @@
also be specified individually, e.g. if the docs should be buildable
without Internet access.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/jsmath.py
View File

@ -6,7 +6,7 @@
Set up everything for use of JSMath to display math in HTML
via JavaScript.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/mathbase.py
View File

@ -5,7 +5,7 @@
Set up math support in source files and LaTeX/text output.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/pngmath.py
View File

@ -5,7 +5,7 @@
Render math in HTML via dvipng.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/refcounting.py
View File

@ -9,7 +9,7 @@
Usage: Set the `refcount_file` config value to the path to the reference
count data file.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/ext/todo.py
View File

@ -8,7 +8,7 @@
all todos of your project and lists them along with a backlink to the
original location.
:copyright: 2008 Daniel Bültmann.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/highlighting.py
View File

@ -5,7 +5,7 @@
Highlight code blocks using Pygments.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/locale/__init__.py
View File

@ -5,7 +5,7 @@
Locale utilities.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/quickstart.py
View File

@ -5,7 +5,7 @@
Quickly setup documentation source to work with Sphinx.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/roles.py
View File

@ -5,7 +5,7 @@
Handlers for additional ReST roles.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/search.py
View File

@ -5,7 +5,7 @@
Create a search index for offline search.
:copyright: 2007-2008 by Armin Ronacher.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import re

4
sphinx/setup_command.py
View File

@ -8,8 +8,8 @@
:author: Sebastian Wiesner
:contact: basti.wiesner@gmx.net
:copyright: 2008 by Sebastian Wiesner.
:license: MIT.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import sys

2
sphinx/util/__init__.py
View File

@ -5,7 +5,7 @@
Utility functions for Sphinx.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/util/compat.py
View File

@ -5,7 +5,7 @@
Stuff for docutils compatibility.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/util/console.py
View File

@ -5,7 +5,7 @@
Format colored console output.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

4
sphinx/util/jsdump.py
View File

@ -4,9 +4,9 @@
~~~~~~~~~~~~~~~~~~
This module implements a simple JavaScript serializer.
Uses the basestring encode function from simplejson.
Uses the basestring encode function from simplejson by Bob Ippolito.
:copyright: 2008 by Armin Ronacher, Bob Ippolito, Georg Brandl.
:copyright: Copyright 2008 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/util/png.py
View File

@ -5,7 +5,7 @@
PNG image manipulation helpers.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/util/stemmer.py
View File

@ -24,7 +24,7 @@
Release 1: January 2001
:copyright: 2001 by Vivake Gupta <v@nano.com>.
:copyright: Copyright 2001 by Vivake Gupta <v@nano.com>.
:license: Public Domain ("can be used free of charge for any purpose").
"""

2
sphinx/util/texescape.py
View File

@ -5,7 +5,7 @@
TeX escaping helper.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/writers/__init__.py
View File

@ -5,6 +5,6 @@
Custom docutils writers.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/writers/html.py
View File

@ -5,7 +5,7 @@
docutils writers handling Sphinx' custom nodes.
:copyright: 2007-2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/writers/latex.py
View File

@ -8,7 +8,7 @@
Much of this code is adapted from Dave Kuhlman's "docpy" writer from his
docutils sandbox.
:copyright: 2007-2008 by Georg Brandl, Dave Kuhlman.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
sphinx/writers/text.py
View File

@ -5,7 +5,7 @@
Custom docutils writer for plain text.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/run.py
View File

@ -6,7 +6,7 @@
This script runs the Sphinx unit test suite.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_application.py
View File

@ -5,7 +5,7 @@
Test the Sphinx class.
:copyright: 2008 by Benjamin Peterson.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_autodoc.py
View File

@ -6,7 +6,7 @@
Test the autodoc extension. This tests mainly the RstGenerator; the auto
directives are tested in a test source file translated by test_build.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_build.py
View File

@ -5,7 +5,7 @@
Test the entire build process with the test root.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_config.py
View File

@ -6,7 +6,7 @@
Test the sphinx.config.Config class and its handling in the
Application class.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_coverage.py
View File

@ -5,7 +5,7 @@
Test the coverage builder.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_env.py
View File

@ -5,7 +5,7 @@
Test the BuildEnvironment class.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_highlighting.py
View File

@ -5,7 +5,7 @@
Test the Pygments highlighting bridge.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_i18n.py
View File

@ -5,7 +5,7 @@
Test locale features.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_markup.py
View File

@ -5,7 +5,7 @@
Test various Sphinx-specific markup extensions.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/test_quickstart.py
View File

@ -5,7 +5,7 @@
Test the sphinx.quickstart module.
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

2
tests/util.py
View File

@ -3,7 +3,7 @@
Sphinx test suite utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: 2008 by Georg Brandl.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""