From: Robert Bradshaw Date: Fri, 1 Apr 2011 18:44:51 +0000 (-0700) Subject: Merge docs repo X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2bcb14fff262a9a9c7b50bacb360bd983e6a92ee;p=cython.git Merge docs repo --- 2bcb14fff262a9a9c7b50bacb360bd983e6a92ee diff --cc docs/.hgignore index 00000000,00000000..23f13a1a new file mode 100644 --- /dev/null +++ b/docs/.hgignore @@@ -1,0 -1,0 +1,9 @@@ ++syntax: glob ++ ++*.pyc ++*~ ++.*.swp ++ ++syntax: regexp ++^build/ ++^_build/ diff --cc docs/Makefile index 00000000,70a45cba..70a45cba mode 000000,100644..100644 --- a/docs/Makefile +++ b/docs/Makefile diff --cc docs/README index 00000000,fa4603fb..fa4603fb mode 000000,100644..100644 --- a/docs/README +++ b/docs/README diff --cc docs/TODO index 00000000,00000000..e69de29b new file mode 100644 --- /dev/null +++ b/docs/TODO diff --cc docs/_static/cython-logo-light.png index 00000000,5fd5f204..5fd5f204 mode 000000,100644..100644 Binary files differ diff --cc docs/_static/cythonlogo.png index 00000000,2b4ee54c..2b4ee54c mode 000000,100644..100644 Binary files differ diff --cc docs/_static/favicon.ico index 00000000,db92af52..db92af52 mode 000000,100644..100644 Binary files differ diff --cc docs/_templates/layout.html index 00000000,a071c96c..a071c96c mode 000000,100644..100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html diff --cc docs/conf.py index 00000000,5607c5f7..5607c5f7 mode 000000,100644..100644 --- a/docs/conf.py +++ b/docs/conf.py diff --cc docs/examples/tutorial/fib1/fib.pyx index 00000000,043d71e5..043d71e5 mode 000000,100644..100644 --- a/docs/examples/tutorial/fib1/fib.pyx +++ b/docs/examples/tutorial/fib1/fib.pyx diff --cc docs/examples/tutorial/fib1/setup.py index 00000000,bda9101b..bda9101b mode 000000,100644..100644 --- a/docs/examples/tutorial/fib1/setup.py +++ b/docs/examples/tutorial/fib1/setup.py diff --cc docs/examples/tutorial/great_circle/c1.pyx index 00000000,c0694a23..c0694a23 mode 000000,100644..100644 --- a/docs/examples/tutorial/great_circle/c1.pyx +++ b/docs/examples/tutorial/great_circle/c1.pyx diff --cc docs/examples/tutorial/great_circle/c2.pyx index 00000000,eb4915ca..eb4915ca mode 000000,100644..100644 --- a/docs/examples/tutorial/great_circle/c2.pyx +++ b/docs/examples/tutorial/great_circle/c2.pyx diff --cc docs/examples/tutorial/great_circle/p1.py index 00000000,c0694a23..c0694a23 mode 000000,100644..100644 --- a/docs/examples/tutorial/great_circle/p1.py +++ b/docs/examples/tutorial/great_circle/p1.py diff --cc docs/examples/tutorial/primes/primes.py index 00000000,a25fdd80..a25fdd80 mode 000000,100644..100644 --- a/docs/examples/tutorial/primes/primes.py +++ b/docs/examples/tutorial/primes/primes.py diff --cc docs/examples/tutorial/primes/primes.pyx index 00000000,63c42a5c..63c42a5c mode 000000,100644..100644 --- a/docs/examples/tutorial/primes/primes.pyx +++ b/docs/examples/tutorial/primes/primes.pyx diff --cc docs/examples/tutorial/primes/setup.py index 00000000,ca5ea49f..ca5ea49f mode 000000,100644..100644 --- a/docs/examples/tutorial/primes/setup.py +++ b/docs/examples/tutorial/primes/setup.py diff --cc docs/index.rst index 00000000,683e6916..683e6916 mode 000000,100644..100644 --- a/docs/index.rst +++ b/docs/index.rst diff --cc docs/sphinxext/cython_highlighting.py index 00000000,3a2e5f9e..3a2e5f9e mode 000000,100644..100644 --- a/docs/sphinxext/cython_highlighting.py +++ b/docs/sphinxext/cython_highlighting.py diff --cc docs/sphinxext/ipython_console_highlighting.py index 00000000,4f0104de..4f0104de mode 000000,100644..100644 --- a/docs/sphinxext/ipython_console_highlighting.py +++ b/docs/sphinxext/ipython_console_highlighting.py diff --cc docs/src/quickstart/build.rst index 00000000,b15987a2..b15987a2 mode 000000,100644..100644 --- a/docs/src/quickstart/build.rst +++ b/docs/src/quickstart/build.rst diff --cc docs/src/quickstart/cythonize.rst index 00000000,04e0d9d1..04e0d9d1 mode 000000,100644..100644 --- a/docs/src/quickstart/cythonize.rst +++ b/docs/src/quickstart/cythonize.rst diff --cc docs/src/quickstart/demo.pyx index 00000000,b1851ff7..b1851ff7 mode 000000,100644..100644 --- a/docs/src/quickstart/demo.pyx +++ b/docs/src/quickstart/demo.pyx diff --cc docs/src/quickstart/htmlreport.png index 00000000,a07a53df..a07a53df mode 000000,100644..100644 Binary files differ diff --cc docs/src/quickstart/index.rst index 00000000,3f2c4398..3f2c4398 mode 000000,100644..100644 --- a/docs/src/quickstart/index.rst +++ b/docs/src/quickstart/index.rst diff --cc docs/src/quickstart/install.rst index 00000000,626b4347..626b4347 mode 000000,100644..100644 --- a/docs/src/quickstart/install.rst +++ b/docs/src/quickstart/install.rst diff --cc docs/src/quickstart/overview.rst index 00000000,f3566882..f3566882 mode 000000,100644..100644 --- a/docs/src/quickstart/overview.rst +++ b/docs/src/quickstart/overview.rst diff --cc docs/src/quickstart/sage.png index 00000000,b19df05d..b19df05d mode 000000,100644..100644 Binary files differ diff --cc docs/src/reference/Makefile index 00000000,00000000..70a45cba new file mode 100644 --- /dev/null +++ b/docs/src/reference/Makefile @@@ -1,0 -1,0 +1,68 @@@ ++# Makefile for Sphinx documentation ++# ++ ++# You can set these variables from the command line. ++SPHINXOPTS = ++SPHINXBUILD = sphinx-build ++PAPER = ++ ++# Internal variables. ++PAPEROPT_a4 = -D latex_paper_size=a4 ++PAPEROPT_letter = -D latex_paper_size=letter ++ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . ++ ++.PHONY: help clean html web htmlhelp latex changes linkcheck ++ ++help: ++ @echo "Please use \`make ' where is one of" ++ @echo " html to make standalone HTML files" ++ @echo " web to make files usable by Sphinx.web" ++ @echo " htmlhelp to make HTML files and a HTML help project" ++ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" ++ @echo " changes to make an overview over all changed/added/deprecated items" ++ @echo " linkcheck to check all external links for integrity" ++ ++clean: ++ -rm -rf build/* ++ ++html: ++ mkdir -p build/html build/doctrees ++ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html ++ @echo ++ @echo "Build finished. The HTML pages are in build/html." ++ ++web: ++ mkdir -p build/web build/doctrees ++ $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) build/web ++ @echo ++ @echo "Build finished; now you can run" ++ @echo " python -m sphinx.web build/web" ++ @echo "to start the server." ++ ++htmlhelp: ++ mkdir -p build/htmlhelp build/doctrees ++ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp ++ @echo ++ @echo "Build finished; now you can run HTML Help Workshop with the" \ ++ ".hhp project file in build/htmlhelp." ++ ++latex: ++ mkdir -p build/latex build/doctrees ++ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex ++ @echo ++ @echo "Build finished; the LaTeX files are in build/latex." ++ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ ++ "run these through (pdf)latex." ++ ++changes: ++ mkdir -p build/changes build/doctrees ++ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes ++ @echo ++ @echo "The overview file is in build/changes." ++ ++linkcheck: ++ mkdir -p build/linkcheck build/doctrees ++ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck ++ @echo ++ @echo "Link check complete; look for any errors in the above output " \ ++ "or in build/linkcheck/output.txt." diff --cc docs/src/reference/compilation.rst index 00000000,e62d9a99..e62d9a99 mode 000000,100644..100644 --- a/docs/src/reference/compilation.rst +++ b/docs/src/reference/compilation.rst diff --cc docs/src/reference/directives.rst index 00000000,33ad093a..33ad093a mode 000000,100644..100644 --- a/docs/src/reference/directives.rst +++ b/docs/src/reference/directives.rst diff --cc docs/src/reference/extension_types.rst index 00000000,46ece2b7..46ece2b7 mode 000000,100644..100644 --- a/docs/src/reference/extension_types.rst +++ b/docs/src/reference/extension_types.rst diff --cc docs/src/reference/index.rst index 00000000,2cd290ae..2cd290ae mode 000000,100644..100644 --- a/docs/src/reference/index.rst +++ b/docs/src/reference/index.rst diff --cc docs/src/reference/interfacing_with_other_code.rst index 00000000,73e2fb8b..73e2fb8b mode 000000,100644..100644 --- a/docs/src/reference/interfacing_with_other_code.rst +++ b/docs/src/reference/interfacing_with_other_code.rst diff --cc docs/src/reference/language_basics.rst index 00000000,b6b05f8f..b6b05f8f mode 000000,100644..100644 --- a/docs/src/reference/language_basics.rst +++ b/docs/src/reference/language_basics.rst diff --cc docs/src/reference/limitations.rst index 00000000,a4a3ff0e..a4a3ff0e mode 000000,100644..100644 --- a/docs/src/reference/limitations.rst +++ b/docs/src/reference/limitations.rst diff --cc docs/src/reference/special_mention.rst index 00000000,0b40771c..0b40771c mode 000000,100644..100644 --- a/docs/src/reference/special_mention.rst +++ b/docs/src/reference/special_mention.rst diff --cc docs/src/reference/special_methods_table.rst index 00000000,d3d1c6fb..d3d1c6fb mode 000000,100644..100644 --- a/docs/src/reference/special_methods_table.rst +++ b/docs/src/reference/special_methods_table.rst diff --cc docs/src/tutorial/appendix.rst index 00000000,4583793d..4583793d mode 000000,100644..100644 --- a/docs/src/tutorial/appendix.rst +++ b/docs/src/tutorial/appendix.rst diff --cc docs/src/tutorial/caveats.rst index 00000000,c4629d9d..c4629d9d mode 000000,100644..100644 --- a/docs/src/tutorial/caveats.rst +++ b/docs/src/tutorial/caveats.rst diff --cc docs/src/tutorial/cdef_classes.rst index 00000000,5a4aff1c..5a4aff1c mode 000000,100644..100644 --- a/docs/src/tutorial/cdef_classes.rst +++ b/docs/src/tutorial/cdef_classes.rst diff --cc docs/src/tutorial/clibraries.rst index 00000000,bebd5846..bebd5846 mode 000000,100644..100644 --- a/docs/src/tutorial/clibraries.rst +++ b/docs/src/tutorial/clibraries.rst diff --cc docs/src/tutorial/data.py index 00000000,f0027629..f0027629 mode 000000,100644..100644 --- a/docs/src/tutorial/data.py +++ b/docs/src/tutorial/data.py diff --cc docs/src/tutorial/external.rst index 00000000,35df8f4c..35df8f4c mode 000000,100644..100644 --- a/docs/src/tutorial/external.rst +++ b/docs/src/tutorial/external.rst diff --cc docs/src/tutorial/index.rst index 00000000,d7972a60..d7972a60 mode 000000,100644..100644 --- a/docs/src/tutorial/index.rst +++ b/docs/src/tutorial/index.rst diff --cc docs/src/tutorial/numpy.rst index 00000000,9551bd00..9551bd00 mode 000000,100644..100644 --- a/docs/src/tutorial/numpy.rst +++ b/docs/src/tutorial/numpy.rst diff --cc docs/src/tutorial/profiling_tutorial.rst index 00000000,5dc6a633..5dc6a633 mode 000000,100644..100644 --- a/docs/src/tutorial/profiling_tutorial.rst +++ b/docs/src/tutorial/profiling_tutorial.rst diff --cc docs/src/tutorial/pure.rst index 00000000,9976e853..9976e853 mode 000000,100644..100644 --- a/docs/src/tutorial/pure.rst +++ b/docs/src/tutorial/pure.rst diff --cc docs/src/tutorial/pxd_files.rst index 00000000,fc85f9dc..fc85f9dc mode 000000,100644..100644 --- a/docs/src/tutorial/pxd_files.rst +++ b/docs/src/tutorial/pxd_files.rst diff --cc docs/src/tutorial/queue_example/cqueue.pxd index 00000000,a6c5d575..a6c5d575 mode 000000,100644..100644 --- a/docs/src/tutorial/queue_example/cqueue.pxd +++ b/docs/src/tutorial/queue_example/cqueue.pxd diff --cc docs/src/tutorial/queue_example/queue.pyx index 00000000,fd8addf7..fd8addf7 mode 000000,100644..100644 --- a/docs/src/tutorial/queue_example/queue.pyx +++ b/docs/src/tutorial/queue_example/queue.pyx diff --cc docs/src/tutorial/readings.rst index 00000000,607e8710..607e8710 mode 000000,100644..100644 --- a/docs/src/tutorial/readings.rst +++ b/docs/src/tutorial/readings.rst diff --cc docs/src/tutorial/related_work.rst index 00000000,cd1d584a..cd1d584a mode 000000,100644..100644 --- a/docs/src/tutorial/related_work.rst +++ b/docs/src/tutorial/related_work.rst diff --cc docs/src/tutorial/strings.rst index 00000000,2c2627fc..2c2627fc mode 000000,100644..100644 --- a/docs/src/tutorial/strings.rst +++ b/docs/src/tutorial/strings.rst diff --cc docs/src/userguide/debugging.rst index 00000000,0f036164..0f036164 mode 000000,100644..100644 --- a/docs/src/userguide/debugging.rst +++ b/docs/src/userguide/debugging.rst diff --cc docs/src/userguide/early_binding_for_speed.rst index 00000000,d44498dd..d44498dd mode 000000,100644..100644 --- a/docs/src/userguide/early_binding_for_speed.rst +++ b/docs/src/userguide/early_binding_for_speed.rst diff --cc docs/src/userguide/extension_types.rst index 00000000,9d37c1db..9d37c1db mode 000000,100644..100644 --- a/docs/src/userguide/extension_types.rst +++ b/docs/src/userguide/extension_types.rst diff --cc docs/src/userguide/external_C_code.rst index 00000000,14910c28..14910c28 mode 000000,100644..100644 --- a/docs/src/userguide/external_C_code.rst +++ b/docs/src/userguide/external_C_code.rst diff --cc docs/src/userguide/index.rst index 00000000,4a08e7c9..4a08e7c9 mode 000000,100644..100644 --- a/docs/src/userguide/index.rst +++ b/docs/src/userguide/index.rst diff --cc docs/src/userguide/language_basics.rst index 00000000,3cbbcc04..3cbbcc04 mode 000000,100644..100644 --- a/docs/src/userguide/language_basics.rst +++ b/docs/src/userguide/language_basics.rst diff --cc docs/src/userguide/limitations.rst index 00000000,6dbadc8f..6dbadc8f mode 000000,100644..100644 --- a/docs/src/userguide/limitations.rst +++ b/docs/src/userguide/limitations.rst diff --cc docs/src/userguide/numpy_tutorial.rst index 00000000,aafeea70..aafeea70 mode 000000,100644..100644 --- a/docs/src/userguide/numpy_tutorial.rst +++ b/docs/src/userguide/numpy_tutorial.rst diff --cc docs/src/userguide/overview.rst index 00000000,6e2a6dbf..6e2a6dbf mode 000000,100644..100644 --- a/docs/src/userguide/overview.rst +++ b/docs/src/userguide/overview.rst diff --cc docs/src/userguide/pxd_package.rst index 00000000,df733e8d..df733e8d mode 000000,100644..100644 --- a/docs/src/userguide/pxd_package.rst +++ b/docs/src/userguide/pxd_package.rst diff --cc docs/src/userguide/pyrex_differences.rst index 00000000,bf7cd03d..bf7cd03d mode 000000,100644..100644 --- a/docs/src/userguide/pyrex_differences.rst +++ b/docs/src/userguide/pyrex_differences.rst diff --cc docs/src/userguide/sharing_declarations.rst index 00000000,ac01815b..ac01815b mode 000000,100644..100644 --- a/docs/src/userguide/sharing_declarations.rst +++ b/docs/src/userguide/sharing_declarations.rst diff --cc docs/src/userguide/source_files_and_compilation.rst index 00000000,32b7df63..32b7df63 mode 000000,100644..100644 --- a/docs/src/userguide/source_files_and_compilation.rst +++ b/docs/src/userguide/source_files_and_compilation.rst diff --cc docs/src/userguide/special_methods.rst index 00000000,2272c628..2272c628 mode 000000,100644..100644 --- a/docs/src/userguide/special_methods.rst +++ b/docs/src/userguide/special_methods.rst diff --cc docs/src/userguide/tutorial.rst index 00000000,47766e2b..47766e2b mode 000000,100644..100644 --- a/docs/src/userguide/tutorial.rst +++ b/docs/src/userguide/tutorial.rst diff --cc docs/src/userguide/wrapping_CPlusPlus.rst index 00000000,22d15857..22d15857 mode 000000,100644..100644 --- a/docs/src/userguide/wrapping_CPlusPlus.rst +++ b/docs/src/userguide/wrapping_CPlusPlus.rst diff --cc docs/todo.txt index 00000000,2c53f42f..2c53f42f mode 000000,100644..100644 --- a/docs/todo.txt +++ b/docs/todo.txt diff --cc docs/welcome.rst index 00000000,aee8d9d8..aee8d9d8 mode 000000,100644..100644 --- a/docs/welcome.rst +++ b/docs/welcome.rst