Skip to content

update website with latest version of sampledoc #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2013
Merged

update website with latest version of sampledoc #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sampledoc/_sources/custom_look.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ the sites created with the default css, so here we'll invoke T. S. Eliot's
maxim "Talent imitates, but genius steals" and grab their css
and part of their layout. As before, you can either get the required
files :file:`_static/default.css`, :file:`_templates/layout.html` and
:file:`_static/logo.png` from the website or svn (see
:ref:`fetching-the-data`). Since I did a svn checkout before, I will
:file:`_static/logo.png` from the website or git (see
:ref:`fetching-the-data`). Since I did a git clone before, I will
just copy the stuff I need from there::

home:~/tmp/sampledoc> cp ../sampledoc_tut/_static/default.css _static/
Expand Down
2 changes: 1 addition & 1 deletion sampledoc/_sources/extensions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sphinx doc directory, and there are other extensions written by other
groups, eg numpy and ipython. We're collecting these in this tutorial
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
directory from git (see :ref:`fetching-the-data`), and install them in
our :file:`sampledoc` project :file:`sphinxext` directory::

home:~/tmp/sampledoc> mkdir sphinxext
Expand Down
33 changes: 13 additions & 20 deletions sampledoc/_sources/getting_started.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,36 +47,29 @@ Fetching the data
-----------------

Now we will start to customize out docs. Grab a couple of files from
the `web site
<http://matplotlib.svn.sourceforge.net/viewvc/matplotlib/trunk/sampledoc_tut/>`_
or svn. You will need :file:`getting_started.rst` and
the `web site <https://github.com/matplotlib/sampledoc>`_
or git. You will need :file:`getting_started.rst` and
:file:`_static/basic_screenshot.png`. All of the files live in the
"completed" version of this tutorial, but since this is a tutorial,
we'll just grab them one at a time, so you can learn what needs to be
changed where. Since we have more files to come, I'm going to grab
the whole svn directory and just copy the files I need over for now.
the whole git directory and just copy the files I need over for now.
First, I'll cd up back into the directory containing my project, check
out the "finished" product from svn, and then copy in just the files I
out the "finished" product from git, and then copy in just the files I
need into my :file:`sampledoc` directory::

home:~/tmp/sampledoc> pwd
/Users/jdhunter/tmp/sampledoc
home:~/tmp/sampledoc> cd ..
home:~/tmp> svn co https://matplotlib.svn.sourceforge.net/svnroot/\
matplotlib/trunk/sampledoc_tut
A sampledoc_tut/cheatsheet.rst
A sampledoc_tut/_static
A sampledoc_tut/_static/basic_screenshot.png
A sampledoc_tut/conf.py
A sampledoc_tut/Makefile
A sampledoc_tut/_templates
A sampledoc_tut/_build
A sampledoc_tut/getting_started.rst
A sampledoc_tut/index.rst
Checked out revision 7449.
home:~/tmp> cp sampledoc_tut/getting_started.rst sampledoc/
home:~/tmp> cp sampledoc_tut/_static/basic_screenshot.png \
sampledoc/_static/
home:~/tmp> git clone https://github.com/matplotlib/sampledoc.git tutorial
Cloning into 'tutorial'...
remote: Counting objects: 87, done.
remote: Compressing objects: 100% (43/43), done.
remote: Total 87 (delta 45), reused 83 (delta 41)
Unpacking objects: 100% (87/87), done.
Checking connectivity... done
home:~/tmp> cp tutorial/getting_started.rst sampledoc/
home:~/tmp> cp tutorial/_static/basic_screenshot.png sampledoc/_static/

The last step is to modify :file:`index.rst` to include the
:file:`getting_started.rst` file (be careful with the indentation, the
Expand Down
4 changes: 2 additions & 2 deletions sampledoc/_sources/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ more. If you follow along the tutorial, you'll start with nothing and
end up with this site -- it's the bootstrapping documentation tutorial
that writes itself!

The source code for this tutorial lives in mpl svn (see
:ref:`fetching-the-data`) and you can grab a harcopy of the the
The source code for this tutorial lives in mpl git (see
:ref:`fetching-the-data`) and you can grab a hardcopy of the
`sampledoc PDF <sampledoc.pdf>`_

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions sampledoc/custom_look.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ <h3>Quick search</h3>
maxim &#8220;Talent imitates, but genius steals&#8221; and grab their css
and part of their layout. As before, you can either get the required
files <tt class="file docutils literal"><span class="pre">_static/default.css</span></tt>, <tt class="file docutils literal"><span class="pre">_templates/layout.html</span></tt> and
<tt class="file docutils literal"><span class="pre">_static/logo.png</span></tt> from the website or svn (see
<a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>). Since I did a svn checkout before, I will
<tt class="file docutils literal"><span class="pre">_static/logo.png</span></tt> from the website or git (see
<a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>). Since I did a git clone before, I will
just copy the stuff I need from there:</p>
<div class="highlight-python"><pre>home:~/tmp/sampledoc&gt; cp ../sampledoc_tut/_static/default.css _static/
home:~/tmp/sampledoc&gt; cp ../sampledoc_tut/_templates/layout.html _templates/
Expand Down
4 changes: 2 additions & 2 deletions sampledoc/extensions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h3>Quick search</h3>
groups, eg numpy and ipython. We&#8217;re collecting these in this tutorial
and showing you how to install and use them for your own project.
First let&#8217;s grab the python extension files from the <tt class="file docutils literal"><span class="pre">sphinxext</span></tt>
directory from svn (see <a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>), and install them in
directory from git (see <a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>), and install them in
our <tt class="file docutils literal"><span class="pre">sampledoc</span></tt> project <tt class="file docutils literal"><span class="pre">sphinxext</span></tt> directory:</p>
<div class="highlight-python"><pre>home:~/tmp/sampledoc&gt; mkdir sphinxext
home:~/tmp/sampledoc&gt; cp ../sampledoc_tut/sphinxext/*.py sphinxext/
Expand Down Expand Up @@ -303,7 +303,7 @@ <h2>This file<a class="headerlink" href="#this-file" title="Permalink to this he
groups, eg numpy and ipython. We're collecting these in this tutorial
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
directory from git (see :ref:`fetching-the-data`), and install them in
our :file:`sampledoc` project :file:`sphinxext` directory::

home:~/tmp/sampledoc&gt; mkdir sphinxext
Expand Down
32 changes: 13 additions & 19 deletions sampledoc/getting_started.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,34 +129,28 @@ <h3>Quick search</h3>
<div class="section" id="fetching-the-data">
<span id="id2"></span><h3>Fetching the data<a class="headerlink" href="#fetching-the-data" title="Permalink to this headline">¶</a></h3>
<p>Now we will start to customize out docs. Grab a couple of files from
the <a class="reference external" href="http://matplotlib.svn.sourceforge.net/viewvc/matplotlib/trunk/sampledoc_tut/">web site</a>
or svn. You will need <tt class="file docutils literal"><span class="pre">getting_started.rst</span></tt> and
the <a class="reference external" href="https://github.com/matplotlib/sampledoc">web site</a>
or git. You will need <tt class="file docutils literal"><span class="pre">getting_started.rst</span></tt> and
<tt class="file docutils literal"><span class="pre">_static/basic_screenshot.png</span></tt>. All of the files live in the
&#8220;completed&#8221; version of this tutorial, but since this is a tutorial,
we&#8217;ll just grab them one at a time, so you can learn what needs to be
changed where. Since we have more files to come, I&#8217;m going to grab
the whole svn directory and just copy the files I need over for now.
the whole git directory and just copy the files I need over for now.
First, I&#8217;ll cd up back into the directory containing my project, check
out the &#8220;finished&#8221; product from svn, and then copy in just the files I
out the &#8220;finished&#8221; product from git, and then copy in just the files I
need into my <tt class="file docutils literal"><span class="pre">sampledoc</span></tt> directory:</p>
<div class="highlight-python"><pre>home:~/tmp/sampledoc&gt; pwd
/Users/jdhunter/tmp/sampledoc
home:~/tmp/sampledoc&gt; cd ..
home:~/tmp&gt; svn co https://matplotlib.svn.sourceforge.net/svnroot/\
matplotlib/trunk/sampledoc_tut
A sampledoc_tut/cheatsheet.rst
A sampledoc_tut/_static
A sampledoc_tut/_static/basic_screenshot.png
A sampledoc_tut/conf.py
A sampledoc_tut/Makefile
A sampledoc_tut/_templates
A sampledoc_tut/_build
A sampledoc_tut/getting_started.rst
A sampledoc_tut/index.rst
Checked out revision 7449.
home:~/tmp&gt; cp sampledoc_tut/getting_started.rst sampledoc/
home:~/tmp&gt; cp sampledoc_tut/_static/basic_screenshot.png \
sampledoc/_static/</pre>
home:~/tmp&gt; git clone https://github.com/matplotlib/sampledoc.git tutorial
Cloning into 'tutorial'...
remote: Counting objects: 87, done.
remote: Compressing objects: 100% (43/43), done.
remote: Total 87 (delta 45), reused 83 (delta 41)
Unpacking objects: 100% (87/87), done.
Checking connectivity... done
home:~/tmp&gt; cp tutorial/getting_started.rst sampledoc/
home:~/tmp&gt; cp tutorial/_static/basic_screenshot.png sampledoc/_static/</pre>
</div>
<p>The last step is to modify <tt class="file docutils literal"><span class="pre">index.rst</span></tt> to include the
<tt class="file docutils literal"><span class="pre">getting_started.rst</span></tt> file (be careful with the indentation, the
Expand Down
4 changes: 2 additions & 2 deletions sampledoc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ <h1>sampledoc tutorial<a class="headerlink" href="#sampledoc-tutorial" title="Pe
more. If you follow along the tutorial, you&#8217;ll start with nothing and
end up with this site &#8211; it&#8217;s the bootstrapping documentation tutorial
that writes itself!</p>
<p>The source code for this tutorial lives in mpl svn (see
<a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>) and you can grab a harcopy of the the
<p>The source code for this tutorial lives in mpl git (see
<a class="reference internal" href="getting_started.html#fetching-the-data"><em>Fetching the data</em></a>) and you can grab a hardcopy of the
<a class="reference external" href="sampledoc.pdf">sampledoc PDF</a></p>
<div class="toctree-wrapper compound">
<ul>
Expand Down
Binary file modified sampledoc/sampledoc.pdf
View file
Open in desktop
Binary file not shown.
Loading