Menu
▾
▴
SF.net SVN: matplotlib:[7461] trunk/py4science/examples/sphinx_qs
|
From: <jd...@us...> - 2009-08-11 11:40:07
|
Revision: 7461
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=7461&view=rev
Author: jdh2358
Date: 2009-08-11 11:40:00 +0000 (Tue, 11 Aug 2009)
Log Message:
-----------
rename project sampledoc
Modified Paths:
--------------
trunk/py4science/examples/sphinx_qs/Makefile
trunk/py4science/examples/sphinx_qs/_static/logo.png
trunk/py4science/examples/sphinx_qs/conf.py
trunk/py4science/examples/sphinx_qs/custom_look.rst
trunk/py4science/examples/sphinx_qs/extensions.rst
trunk/py4science/examples/sphinx_qs/getting_started.rst
trunk/py4science/examples/sphinx_qs/index.rst
Modified: trunk/py4science/examples/sphinx_qs/Makefile
===================================================================
--- trunk/py4science/examples/sphinx_qs/Makefile 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/Makefile 2009-08-11 11:40:00 UTC (rev 7461)
@@ -60,9 +60,9 @@
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in _build/qthelp, like this:"
- @echo "# qcollectiongenerator _build/qthelp/py4sci.qhcp"
+ @echo "# qcollectiongenerator _build/qthelp/sampledoc.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile _build/qthelp/py4sci.qhc"
+ @echo "# assistant -collectionFile _build/qthelp/sampledoc.qhc"
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
Modified: trunk/py4science/examples/sphinx_qs/_static/logo.png
===================================================================
(Binary files differ)
Modified: trunk/py4science/examples/sphinx_qs/conf.py
===================================================================
--- trunk/py4science/examples/sphinx_qs/conf.py 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/conf.py 2009-08-11 11:40:00 UTC (rev 7461)
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# py4sci documentation build configuration file, created by
+# sampledoc documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 11 05:04:40 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
@@ -45,7 +45,7 @@
master_doc = 'index'
# General information about the project.
-project = u'py4sci'
+project = u'sampledoc'
copyright = u'2009, jdh'
# The version info for the project you're documenting, acts as replacement for
@@ -166,7 +166,7 @@
#html_file_suffix = ''
# Output file base name for HTML help builder.
-htmlhelp_basename = 'py4scidoc'
+htmlhelp_basename = 'sampledocdoc'
# -- Options for LaTeX output --------------------------------------------------
@@ -180,7 +180,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'py4sci.tex', u'py4sci Documentation',
+ ('index', 'sampledoc.tex', u'sampledoc Documentation',
u'jdh', 'manual'),
]
Modified: trunk/py4science/examples/sphinx_qs/custom_look.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/custom_look.rst 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/custom_look.rst 2009-08-11 11:40:00 UTC (rev 7461)
@@ -14,10 +14,10 @@
:ref:`fetching-the-data`). Since I did a svn checkout before, I will
just copy the stuff I need from there::
- home:~/tmp/py4sci> cp ../sphinx_qs/_static/default.css _static/
- home:~/tmp/py4sci> cp ../sphinx_qs/_templates/layout.html _templates/
- home:~/tmp/py4sci> cp ../sphinx_qs/_static/logo.png _static/
- home:~/tmp/py4sci> ls _static/ _templates/
+ home:~/tmp/sampledoc> cp ../sphinx_qs/_static/default.css _static/
+ home:~/tmp/sampledoc> cp ../sphinx_qs/_templates/layout.html _templates/
+ home:~/tmp/sampledoc> cp ../sphinx_qs/_static/logo.png _static/
+ home:~/tmp/sampledoc> ls _static/ _templates/
_static/:
basic_screenshot.png default.css logo.png
@@ -48,7 +48,7 @@
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="{{ pathto('index') }}"><img src="{{
- pathto("_static/logo.png", 1) }}" border="0" alt="py4sci"/></a>
+ pathto("_static/logo.png", 1) }}" border="0" alt="sampledoc"/></a>
</div>
{{ super() }}
{% endblock %}
Modified: trunk/py4science/examples/sphinx_qs/extensions.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/extensions.rst 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/extensions.rst 2009-08-11 11:40:00 UTC (rev 7461)
@@ -14,11 +14,11 @@
and showing you how to install and use them for your own project.
First let's grab the python extension files from the :file:`sphinxext`
directory from svn (see :ref:`fetching-the-data`, and install them in
-our :file:`py4sci` project :file:`sphinxext` directory::
+our :file:`sampledoc` project :file:`sphinxext` directory::
- home:~/tmp/py4sci> mkdir sphinxext
- home:~/tmp/py4sci> cp ../sphinx_qs/sphinxext/*.py sphinxext/
- home:~/tmp/py4sci> ls sphinxext/
+ home:~/tmp/sampledoc> mkdir sphinxext
+ home:~/tmp/sampledoc> cp ../sphinx_qs/sphinxext/*.py sphinxext/
+ home:~/tmp/sampledoc> ls sphinxext/
apigen.py inheritance_diagram.py
docscrape.py ipython_console_highlighting.py
docscrape_sphinx.py numpydoc.py
Modified: trunk/py4science/examples/sphinx_qs/getting_started.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/getting_started.rst 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/getting_started.rst 2009-08-11 11:40:00 UTC (rev 7461)
@@ -27,10 +27,10 @@
> sphinx-quickstart
-accepting most of the defaults. I choose "py4sci" as the name of my
+accepting most of the defaults. I choose "sampledoc" as the name of my
project. cd into your new directory and check the contents::
- home:~/tmp/py4sci> ls
+ home:~/tmp/sampledoc> ls
Makefile _static conf.py
_build _templates index.rst
@@ -61,9 +61,9 @@
First, I'll cd to the directory containing my project, and get the
"finished" product, and then copy in just the files I need::
- home:~/tmp/py4sci> pwd
- /Users/jdhunter/tmp/py4sci
- home:~/tmp/py4sci> cd ..
+ home:~/tmp/sampledoc> pwd
+ /Users/jdhunter/tmp/sampledoc
+ home:~/tmp/sampledoc> cd ..
home:~/tmp> svn co
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/\
py4science/examples/sphinx_qs
@@ -77,8 +77,8 @@
A sphinx_qs/getting_started.rst
A sphinx_qs/index.rst
Checked out revision 7449.
- home:~/tmp> cp sphinx_qs/getting_started.rst py4sci/
- home:~/tmp> cp sphinx_qs/_static/basic_screenshot.png py4sci/_static/
+ home:~/tmp> cp sphinx_qs/getting_started.rst sampledoc/
+ home:~/tmp> cp sphinx_qs/_static/basic_screenshot.png sampledoc/_static/
Now we are ready to rebuild the docs. We used the image directory to
include to the screenshot above with::
Modified: trunk/py4science/examples/sphinx_qs/index.rst
===================================================================
--- trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 11:33:59 UTC (rev 7460)
+++ trunk/py4science/examples/sphinx_qs/index.rst 2009-08-11 11:40:00 UTC (rev 7461)
@@ -1,10 +1,10 @@
-.. py4sci documentation master file, created by
+.. sampledoc documentation master file, created by
sphinx-quickstart on Tue Aug 11 05:04:40 2009.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to py4sci's documentation!
-==================================
+sampledoc tutorial
+==================
Contents:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
