[Scipy-svn] r4850 - in scipy-docs/trunk: . frontpage frontpage/_static frontpage/_templates

scipy-svn@scip... scipy-svn@scip...
Sun Oct 26 13:10:36 CDT 2008


Author: ptvirtan
Date: 2008-10-26 13:10:15 -0500 (Sun, 26 Oct 2008)
New Revision: 4850

Added:
   scipy-docs/trunk/frontpage/
   scipy-docs/trunk/frontpage/Makefile
   scipy-docs/trunk/frontpage/README.txt
   scipy-docs/trunk/frontpage/_static/
   scipy-docs/trunk/frontpage/_static/scipy.css
   scipy-docs/trunk/frontpage/_templates/
   scipy-docs/trunk/frontpage/_templates/download.html
   scipy-docs/trunk/frontpage/_templates/indexcontent.html
   scipy-docs/trunk/frontpage/_templates/indexsidebar.html
   scipy-docs/trunk/frontpage/_templates/layout.html
   scipy-docs/trunk/frontpage/conf.py
   scipy-docs/trunk/frontpage/contents.rst
   scipy-docs/trunk/frontpage/scipyshiny_small.png
Log:
Add docs.scipy.org front page source

Added: scipy-docs/trunk/frontpage/Makefile
===================================================================
--- scipy-docs/trunk/frontpage/Makefile	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/Makefile	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,84 @@
+# 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 pickle htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@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/*
+
+dist: html
+	rm -rf _build/doc
+	cp -r _build/html _build/doc
+	rm _build/doc/objects.inv
+	rm _build/doc/contents.html
+	rm _build/doc/search.html
+	rm _build/doc/searchindex.js
+	cd _build/doc && tar czf ../frontpage.tar.gz *
+
+html:
+	mkdir -p _build/html _build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html."
+
+pickle:
+	mkdir -p _build/pickle _build/doctrees
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+web: pickle
+
+json:
+	mkdir -p _build/json _build/doctrees
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+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."


Property changes on: scipy-docs/trunk/frontpage/Makefile
___________________________________________________________________
Name: svn:eol-style
   + native

Added: scipy-docs/trunk/frontpage/README.txt
===================================================================
--- scipy-docs/trunk/frontpage/README.txt	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/README.txt	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,7 @@
+docs.scipy.org front page
+=========================
+
+Instructions
+------------
+1. Run ``make html`` or ``make dist``
+


Property changes on: scipy-docs/trunk/frontpage/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: scipy-docs/trunk/frontpage/_static/scipy.css
===================================================================
--- scipy-docs/trunk/frontpage/_static/scipy.css	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/_static/scipy.css	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,156 @@
+@import "default.css";
+
+/**
+ * Spacing fixes
+ */
+
+div.body p, div.body dd, div.body li {
+  line-height: 125%;
+}
+
+ul.simple { 
+    margin-top: 0;
+    margin-bottom: 0;
+    padding-top: 0;
+    padding-bottom: 0;
+}
+
+/* spacing around blockquoted fields in parameters/attributes/returns */
+td.field-body > blockquote {
+    margin-top: 0.1em;
+    margin-bottom: 0.5em;
+}
+
+/* spacing around example code */
+div.highlight > pre {
+    padding: 2px 5px 2px 5px;
+}
+
+/* spacing in see also definition lists */
+dl.last > dd {
+    margin-top: 1px;
+    margin-bottom: 5px;
+    margin-left: 30px;
+}
+
+/**
+ * Hide dummy toctrees 
+ */
+
+ul { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+ul li { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+ul li a.reference { 
+  padding-top: 0;
+  padding-bottom: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+/**
+ * Make high-level subsections easier to distinguish from top-level ones
+ */
+div.body h3 { 
+  background-color: transparent;
+}
+
+div.body h4 { 
+  border: none;
+  background-color: transparent;
+}
+
+/** 
+ * Scipy colors
+ */
+
+body { 
+  background-color: rgb(100,135,220);
+}
+
+div.document { 
+  background-color: rgb(230,230,230);
+}
+
+div.sphinxsidebar {
+  background-color: rgb(230,230,230);
+  overflow: hidden;
+}
+
+div.related {
+  background-color: rgb(100,135,220);
+}
+
+div.sphinxsidebar h3 {
+  color: rgb(0,102,204);
+}
+
+div.sphinxsidebar h3 a {
+  color: rgb(0,102,204);
+}
+
+div.sphinxsidebar h4 {
+  color: rgb(0,82,194);
+}
+
+div.sphinxsidebar p {
+  color: black;
+}
+
+div.sphinxsidebar a {
+  color: #355f7c;
+}
+
+div.sphinxsidebar ul.want-points {
+  list-style: disc;
+}
+
+.field-list th {
+  color: rgb(0,102,204);
+}
+
+/** 
+ * Extra admonitions 
+ */
+
+div.tip {
+  background-color: #ffffe4;
+  border: 1px solid #ee6;
+}
+
+/*
+div.admonition-example {
+    background-color: #e4ffe4;
+    border: 1px solid #ccc;
+}*/
+
+
+/**
+ * Styling for field lists
+ */
+
+table.field-list th {
+  border-left: 1px solid #aaa !important;
+  padding-left: 5px;
+}
+
+table.field-list { 
+  border-collapse: separate;
+  border-spacing: 10px;
+}
+
+/** 
+ * Styling for footnotes
+ */
+
+table.footnote td, table.footnote th {
+  border: none;
+}

Added: scipy-docs/trunk/frontpage/_templates/download.html
===================================================================
--- scipy-docs/trunk/frontpage/_templates/download.html	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/_templates/download.html	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,52 @@
+{% extends "layout.html" %}
+{% set title = 'Download' %}
+{% block body %}
+
+<h1>Download Scipy and Numpy Documentation</h1>
+
+<p>This documentation on this site is available for download in
+  the following formats:</p>
+
+<table>
+  <tr>
+    <td><a href="numpy/numpy-html.zip">HTML (zip)</a></td>
+    <td>ca. 3 MB</td>
+    <td>Numpy HTML documentation, packaged.</td>
+  </tr>
+  <tr>
+    <td><a href="numpy/numpy-ref.pdf">PDF (Numpy reference)</a></td>
+    <td>ca. 2 MB</td>
+    <td>Numpy reference guide, as PDF.</td>
+  </tr>
+  <tr>
+    <td><a href="numpy/numpy-user.pdf">PDF (Numpy user guide)</a></td>
+    <td>ca. 0.5 MB</td>
+    <td>Numpy's User Guide (work-in-progress) part, as PDF.</td>
+  </tr>
+  <tr>
+    <td><a href="scipy/scipy-html.zip">HTML (zip)</a></td>
+    <td>ca. 3 MB</td>
+    <td>Scipy HTML documentation, packaged.</td>
+  </tr>
+  <tr>
+    <td><a href="scipy/scipy-ref.pdf">PDF (Scipy reference)</a></td>
+    <td>ca. 2 MB</td>
+    <td>Scipy reference guide (work-in-progress), as PDF.</td>
+  </tr>
+</table>
+
+<p>Additionally, you may be interested in</p>
+
+<table>
+  <tr>
+    <td><a href="http://www.tramy.us/">Guide to Numpy</a></td>
+    <td>The original Numpy reference book, by Travis Oliphant.</td>
+  </tr>
+  <tr>
+    <td><a href="http://scipy.org/Documentation">Scipy.org website</a></td>
+    <td>Additional community-contributed documentation, tutorials,
+      examples, etc.</td>
+  </tr>
+</table>
+
+{% endblock %}

Added: scipy-docs/trunk/frontpage/_templates/indexcontent.html
===================================================================
--- scipy-docs/trunk/frontpage/_templates/indexcontent.html	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/_templates/indexcontent.html	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,43 @@
+{% extends "defindex.html" %}
+{% block tables %}
+  <p><strong>Parts of the documentation:</strong></p>
+  <table class="contentstable" align="center"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="numpy/reference/">Numpy Reference</a><br/>
+         <span class="linkdescr">reference documentation for Numpy</span></p>
+      <p class="biglink"><a class="biglink" href="http://www.tramy.us/numpybook.pdf">Guide to Numpy</a><br/>
+         <span class="linkdescr">book describing Numpy, by Travis Oliphant</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="http://www.scipy.org/Documentation">SciPy.org</a><br/>
+         <span class="linkdescr">more documentation on the scipy.org website</span></p>
+    </td></tr>
+  </table>
+
+  <p><strong>Work in progress:</strong></p>
+  <table class="contentstable" align="center"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="numpy/user/">Numpy User Guide</a><br/>
+         <span class="linkdescr">user guide for Numpy</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="scipy/reference/">Scipy Reference Guide</a><br/>
+         <span class="linkdescr">reference documentation for Scipy</span></p>
+    </td></tr>
+  </table>
+
+  <p><strong>Participate:</strong></p>
+  <table class="contentstable" align="center"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="http://www.scipy.org/BugReport">Reporting bugs</a><br/>
+         <span class="linkdescr">reporting defects in Numpy and Scipy</span></p>
+      <p class="biglink"><a class="biglink" href="http://www.scipy.org/Developer_Zone">Developer Zone</a><br/>
+         <span class="linkdescr">information about Numpy and Scipy development</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="http://docs.scipy.org/numpy/">Numpy Documentation Marathon</a><br/>
+         <span class="linkdescr">improve this documentation</span></p>
+    </td></tr>
+  </table>
+
+{% endblock %}
+
+{% block sidebarsearch %}
+{% endblock %}

Added: scipy-docs/trunk/frontpage/_templates/indexsidebar.html
===================================================================
--- scipy-docs/trunk/frontpage/_templates/indexsidebar.html	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/_templates/indexsidebar.html	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,12 @@
+            <h3>Download</h3>
+            <ul>
+              <li><a href="{{ pathto('download') }}">Download these documents</a></li>
+            </ul>
+
+            <h3>Resources</h3>
+            <ul>
+              <li><a href="http://scipy.org/">Scipy.org website</a></li>
+              <li>&nbsp;</li>
+              <li><a href="numpy/glossary.html">Glossary</a></li>
+              <li>&nbsp;</li>
+            </ul>

Added: scipy-docs/trunk/frontpage/_templates/layout.html
===================================================================
--- scipy-docs/trunk/frontpage/_templates/layout.html	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/_templates/layout.html	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,4 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+<li><a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
+{% endblock %}

Added: scipy-docs/trunk/frontpage/conf.py
===================================================================
--- scipy-docs/trunk/frontpage/conf.py	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/conf.py	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+#
+# Numpy/Scipy Documentation documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 23 20:48:29 2008.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'Numpy and Scipy'
+copyright = u'2008, Scipy Community'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'scipy.css'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = "Numpy and Scipy Documentation"
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = "scipyshiny_small.png"
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index': 'indexsidebar.html'
+}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+html_additional_pages = {
+    'index': 'indexcontent.html',
+    'download': 'download.html',
+}
+
+# If false, no module index is generated.
+html_use_modindex = False
+
+# If false, no index is generated.
+html_use_index = False
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+html_copy_source = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'NumpyScipyDocumentationdoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [ ] 
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True

Added: scipy-docs/trunk/frontpage/contents.rst
===================================================================
--- scipy-docs/trunk/frontpage/contents.rst	2008-10-26 17:54:24 UTC (rev 4849)
+++ scipy-docs/trunk/frontpage/contents.rst	2008-10-26 18:10:15 UTC (rev 4850)
@@ -0,0 +1 @@
+.. All the content is under _templates/

Added: scipy-docs/trunk/frontpage/scipyshiny_small.png
===================================================================
(Binary files differ)


Property changes on: scipy-docs/trunk/frontpage/scipyshiny_small.png
___________________________________________________________________
Name: svn:mime-type
   + image/png



More information about the Scipy-svn mailing list