matplotlib.github.com/sampledoc/getting_started.html at main · matplotlib/matplotlib.github.com · GitHub

History

222 lines (205 loc) · 14.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Getting started — sampledoc 1.0 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: './',

VERSION: '1.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

</head>

<a href="index.html"><h1 style="font-size: 3em;">Sampledoc</h1></a>

</div>

<h3>Navigation</h3>

<ul>

<a href="genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="custom_look.html" title="Customizing the look and feel of the site"

accesskey="N">next</a> |</li>

<a href="index.html" title="sampledoc tutorial"

accesskey="P">previous</a> |</li>

<li><a href="search.html">search</a>| </li>

</ul>

</div>

<h3><a href="index.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Getting started</a><ul>

<li><a class="reference internal" href="#installing-your-doc-directory">Installing your doc directory</a><ul>

<li><a class="reference internal" href="#fetching-the-data">Fetching the data</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="index.html"

title="previous chapter">sampledoc tutorial</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="custom_look.html"

title="next chapter">Customizing the look and feel of the site</a></p>

<li><a href="_sources/getting_started.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="id1"></span><h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>

<span id="installing-docdir"></span><h2>Installing your doc directory<a class="headerlink" href="#installing-your-doc-directory" title="Permalink to this headline">¶</a></h2>

<p>You may already have sphinx <a class="reference external" href="http://sphinx.pocoo.org/">sphinx</a>

installed – you can check by doing:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s1">'import sphinx'</span>

</pre></div>

</div>

<p>If that fails grab the latest version of and install it with:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">></span> <span class="n">sudo</span> <span class="n">easy_install</span> <span class="o">-</span><span class="n">U</span> <span class="n">Sphinx</span>

</pre></div>

</div>

<p>Now you are ready to build a template for your docs, using

sphinx-quickstart:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">></span> <span class="n">sphinx</span><span class="o">-</span><span class="n">quickstart</span>

</pre></div>

</div>

<p>accepting most of the defaults. I choose “sampledoc” as the name of my

project. cd into your new directory and check the contents:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">tmp</span><span class="o">/</span><span class="n">sampledoc</span><span class="o">></span> <span class="n">ls</span>

<span class="n">Makefile</span> <span class="n">_static</span> <span class="n">conf</span><span class="o">.</span><span class="n">py</span>

<span class="n">_build</span> <span class="n">_templates</span> <span class="n">index</span><span class="o">.</span><span class="n">rst</span>

</pre></div>

</div>

<p>The index.rst is the master ReST for your project, but before adding

anything, let’s see if we can build some html:</p>

</pre></div>

</div>

<p>If you now point your browser to <code class="file docutils literal"><span class="pre">_build/html/index.html</span></code>, you

should see a basic sphinx site.</p>

<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="https://github.com/matplotlib/sampledoc">web site</a>

or git. You will need <code class="file docutils literal"><span class="pre">getting_started.rst</span></code> and

<code class="file docutils literal"><span class="pre">_static/basic_screenshot.png</span></code>. 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 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 git, and then copy in just the files I

need into my <code class="file docutils literal"><span class="pre">sampledoc</span></code> directory:</p>

<span class="o">/</span><span class="n">Users</span><span class="o">/</span><span class="n">jdhunter</span><span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">sampledoc</span>

<span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">tmp</span><span class="o">/</span><span class="n">sampledoc</span><span class="o">></span> <span class="n">cd</span> <span class="o">..</span>

<span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">tmp</span><span class="o">></span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">sampledoc</span><span class="o">.</span><span class="n">git</span> <span class="n">tutorial</span>

<span class="n">Cloning</span> <span class="n">into</span> <span class="s1">'tutorial'</span><span class="o">...</span>

<span class="n">remote</span><span class="p">:</span> <span class="n">Counting</span> <span class="n">objects</span><span class="p">:</span> <span class="mi">87</span><span class="p">,</span> <span class="n">done</span><span class="o">.</span>

<span class="n">remote</span><span class="p">:</span> <span class="n">Compressing</span> <span class="n">objects</span><span class="p">:</span> <span class="mi">100</span><span class="o">%</span> <span class="p">(</span><span class="mi">43</span><span class="o">/</span><span class="mi">43</span><span class="p">),</span> <span class="n">done</span><span class="o">.</span>

<span class="n">remote</span><span class="p">:</span> <span class="n">Total</span> <span class="mi">87</span> <span class="p">(</span><span class="n">delta</span> <span class="mi">45</span><span class="p">),</span> <span class="n">reused</span> <span class="mi">83</span> <span class="p">(</span><span class="n">delta</span> <span class="mi">41</span><span class="p">)</span>

<span class="n">Unpacking</span> <span class="n">objects</span><span class="p">:</span> <span class="mi">100</span><span class="o">%</span> <span class="p">(</span><span class="mi">87</span><span class="o">/</span><span class="mi">87</span><span class="p">),</span> <span class="n">done</span><span class="o">.</span>

<span class="n">Checking</span> <span class="n">connectivity</span><span class="o">...</span> <span class="n">done</span>

<span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">tmp</span><span class="o">></span> <span class="n">cp</span> <span class="n">tutorial</span><span class="o">/</span><span class="n">getting_started</span><span class="o">.</span><span class="n">rst</span> <span class="n">sampledoc</span><span class="o">/</span>

<span class="n">home</span><span class="p">:</span><span class="o">~/</span><span class="n">tmp</span><span class="o">></span> <span class="n">cp</span> <span class="n">tutorial</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">basic_screenshot</span><span class="o">.</span><span class="n">png</span> <span class="n">sampledoc</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span>

</pre></div>

</div>

<p>The last step is to modify <code class="file docutils literal"><span class="pre">index.rst</span></code> to include the

<code class="file docutils literal"><span class="pre">getting_started.rst</span></code> file (be careful with the indentation, the

“g” in “getting_started” should line up with the ‘:’ in <code class="docutils literal"><span class="pre">:maxdepth</span></code>:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Contents</span><span class="p">:</span>

<span class="o">..</span> <span class="n">toctree</span><span class="p">::</span>

<span class="p">:</span><span class="n">maxdepth</span><span class="p">:</span> <span class="mi">2</span>

<span class="n">getting_started</span><span class="o">.</span><span class="n">rst</span>

</pre></div>

</div>

<p>and then rebuild the docs:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">sampledoc</span>

</pre></div>

</div>

<p>When you reload the page by refreshing your browser pointing to

<code class="file docutils literal"><span class="pre">_build/html/index.html</span></code>, you should see a link to the

“Getting Started” docs, and in there this page with the screenshot.

<cite>Voila!</cite></p>

<p>Note we used the image directive to include to the screenshot above

with:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">image</span><span class="p">::</span> <span class="n">_static</span><span class="o">/</span><span class="n">basic_screenshot</span><span class="o">.</span><span class="n">png</span>

</pre></div>

</div>

<p>Next we’ll customize the look and feel of our site to give it a logo,

some custom css, and update the navigation panels to look more like

the <a class="reference external" href="http://sphinx.pocoo.org/">sphinx</a> site itself – see

<a class="reference internal" href="custom_look.html#custom-look"><span class="std std-ref">Customizing the look and feel of the site</span></a>.</p>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="genindex.html" title="General Index"

>index</a></li>

<a href="custom_look.html" title="Customizing the look and feel of the site"

>next</a> |</li>

<a href="index.html" title="sampledoc tutorial"

>previous</a> |</li>

<li><a href="search.html">search</a>| </li>

</ul>

</div>

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.

</div>

</body>

</html>

matplotlib.github.com/sampledoc/getting_started.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

getting_started.html

Latest commit

History

Breadcrumbs

getting_started.html

File metadata and controls