/usr/share/doc/pelican-doc/html/install.html is in pelican-doc 3.7.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installing Pelican — Pelican 3.7.1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.7.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Pelican 3.7.1 documentation" href="index.html" />
<link rel="next" title="Writing content" href="content.html" />
<link rel="prev" title="Quickstart" href="quickstart.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="content.html" title="Writing content"
accesskey="N">next</a></li>
<li class="right" >
<a href="quickstart.html" title="Quickstart"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pelican 3.7.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="installing-pelican">
<h1>Installing Pelican<a class="headerlink" href="#installing-pelican" title="Permalink to this headline">¶</a></h1>
<p>Pelican currently runs best on Python 2.7.x and 3.3+; earlier versions of
Python are not supported.</p>
<p>You can install Pelican via several different methods. The simplest is via
<a class="reference external" href="http://www.pip-installer.org/">pip</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pelican</span>
</pre></div>
</div>
<p>(Keep in mind that operating systems will often require you to prefix the above
command with <code class="docutils literal"><span class="pre">sudo</span></code> in order to install Pelican system-wide.)</p>
<p>While the above is the simplest method, the recommended approach is to create
a virtual environment for Pelican via <a class="reference external" href="http://www.virtualenv.org/">virtualenv</a> before installing Pelican.
Assuming you have <a class="reference external" href="http://www.virtualenv.org/">virtualenv</a> installed, you can then open a new terminal
session and create a new virtual environment for Pelican:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">virtualenv</span> <span class="o">~/</span><span class="n">virtualenvs</span><span class="o">/</span><span class="n">pelican</span>
<span class="n">cd</span> <span class="o">~/</span><span class="n">virtualenvs</span><span class="o">/</span><span class="n">pelican</span>
<span class="n">source</span> <span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
</pre></div>
</div>
<p>Once the virtual environment has been created and activated, Pelican can be
installed via <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">pelican</span></code> as noted above. Alternatively, if
you have the project source, you can install Pelican using the distutils
method:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">path</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">Pelican</span><span class="o">-</span><span class="n">source</span>
<span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>If you have Git installed and prefer to install the latest bleeding-edge
version of Pelican rather than a stable release, use the following command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"git+https://github.com/getpelican/pelican.git#egg=pelican"</span>
</pre></div>
</div>
<p>Once Pelican is installed, you can run <code class="docutils literal"><span class="pre">pelican</span> <span class="pre">--help</span></code> to see basic usage
options. For more detail, refer to the <a class="reference internal" href="publish.html"><span class="doc">Publish</span></a> section.</p>
<div class="section" id="optional-packages">
<h2>Optional packages<a class="headerlink" href="#optional-packages" title="Permalink to this headline">¶</a></h2>
<p>If you plan on using <a class="reference external" href="http://pypi.python.org/pypi/Markdown">Markdown</a> as a
markup format, you’ll need to install the Markdown library:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">Markdown</span>
</pre></div>
</div>
<p>Typographical enhancements can be enabled in your settings file, but first the
requisite <a class="reference external" href="http://pypi.python.org/pypi/typogrify">Typogrify</a> library must be
installed:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">typogrify</span>
</pre></div>
</div>
</div>
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p>When Pelican is installed, the following dependent Python packages should be
automatically installed without any action on your part:</p>
<ul class="simple">
<li><a class="reference external" href="http://pypi.python.org/pypi/feedgenerator">feedgenerator</a>, to generate the
Atom feeds</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/Jinja2">jinja2</a>, for templating support</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/Pygments">pygments</a>, for syntax highlighting</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/docutils">docutils</a>, for supporting
reStructuredText as an input format</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/pytz">pytz</a>, for timezone definitions</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/blinker">blinker</a>, an object-to-object and
broadcast signaling system</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/Unidecode">unidecode</a>, for ASCII
transliterations of Unicode text</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/six">six</a>, for Python 2 and 3 compatibility
utilities</li>
<li><a class="reference external" href="http://pypi.python.org/pypi/MarkupSafe">MarkupSafe</a>, for a markup safe
string implementation</li>
<li><a class="reference external" href="https://pypi.python.org/pypi/python-dateutil">python-dateutil</a>, to read
the date metadata</li>
</ul>
</div>
<div class="section" id="upgrading">
<h2>Upgrading<a class="headerlink" href="#upgrading" title="Permalink to this headline">¶</a></h2>
<p>If you installed a stable Pelican release via <code class="docutils literal"><span class="pre">pip</span></code> and wish to upgrade to
the latest stable release, you can do so by adding <code class="docutils literal"><span class="pre">--upgrade</span></code>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pelican</span>
</pre></div>
</div>
<p>If you installed Pelican via distutils or the bleeding-edge method, simply
perform the same step to install the most recent version.</p>
</div>
<div class="section" id="kickstart-your-site">
<h2>Kickstart your site<a class="headerlink" href="#kickstart-your-site" title="Permalink to this headline">¶</a></h2>
<p>Once Pelican has been installed, you can create a skeleton project via the
<code class="docutils literal"><span class="pre">pelican-quickstart</span></code> command, which begins by asking some questions about
your site:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pelican</span><span class="o">-</span><span class="n">quickstart</span>
</pre></div>
</div>
<p>Once you finish answering all the questions, your project will consist of the
following hierarchy (except for <em>pages</em> — shown in parentheses below — which you
can optionally add yourself if you plan to create non-chronological content):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>yourproject/
├── content
│ └── (pages)
├── output
├── develop_server.sh
├── fabfile.py
├── Makefile
├── pelicanconf.py # Main settings file
└── publishconf.py # Settings to use when ready to publish
</pre></div>
</div>
<p>The next step is to begin to adding content to the <em>content</em> folder that has
been created for you.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installing Pelican</a><ul>
<li><a class="reference internal" href="#optional-packages">Optional packages</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#upgrading">Upgrading</a></li>
<li><a class="reference internal" href="#kickstart-your-site">Kickstart your site</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="quickstart.html"
title="previous chapter">Quickstart</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="content.html"
title="next chapter">Writing content</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="content.html" title="Writing content"
>next</a></li>
<li class="right" >
<a href="quickstart.html" title="Quickstart"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pelican 3.7.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Alexis Metaireau and contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>
|