Anonymous avatar Anonymous committed a8dd86c

Use Windows-friendlier dirnames.

Comments (0)

Files changed (10)

Add a comment to this file

doc/.static/sphinx.png

Removed
Old image

doc/.templates/index.html

-{% extends "layout.html" %}
-{% set title = 'Overview' %}
-{% block body %}
-  <p style="background-color: #fcc; font-size: large; border: 1px solid #f00; padding: 10px;">
-    <b>Attention:</b> this is a preview. Sphinx is not released yet on PyPI,
-    and the contents of this documentation are subject to change.
-  </p>
-
-  <h1>Welcome</h1>
-
-  <p>
-    Sphinx is a tool that makes it easy to create intelligent and beautiful
-    documentation for Python projects, written by Georg Brandl.  It was
-    originally created to translate <a href="http://docs.python.org/dev/">the
-    new Python documentation</a>, but has now been cleaned up in the hope that
-    it will be useful to many other projects.  (Of course, this site is also
-    created from reStructuredText sources using Sphinx!)
-
-  </p>
-  <p>
-    Although it is still under constant development, the following features are
-    already present, work fine and can be seen &#8220;in action&#8221; in the
-    Python docs:
-  </p>
-  <ul>
-    <li><b>Output formats:</b> HTML (including Windows HTML Help) and LaTeX, for
-    printable PDF versions</li>
-    <li><b>Extensive cross-references:</b> semantic markup and automatic links
-    for functions, classes, glossary terms and similar pieces of information</li>
-    <li><b>Hierarchical structure:</b> easy definition of a document tree, with
-    automatic links to siblings, parents and children</li>
-    <li><b>Automatic indices:</b> general index as well as a module index</li>
-    <li><b>Code handling:</b> automatic highlighting using the <a
-    href="http://pygments.org">Pygments</a> highlighter</li>
-  </ul>
-  <p>
-    Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a>
-    as its markup language, and many of its strengths come from the power and
-    straightforwardness of reStructuredText and its parsing and translating
-    suite, the <a href="http://docutils.sf.net/">Docutils</a>.
-  </p>
-
-  <h2>Documentation</h2>
-  <table class="contentstable" align="center" style="margin-left: 30px"><tr>
-    <td width="50%">
-      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br>
-         <span class="linkdescr">for a complete overview</span></p>
-      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br>
-         <span class="linkdescr">search the documentation</span></p>
-    </td><td width="50%">
-      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br>
-         <span class="linkdescr">all functions, classes, terms</span></p>
-      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Module Index</a><br>
-         <span class="linkdescr">quick access to all documented modules</span></p>
-    </td></tr>
-  </table>
-
-  <h2>Get Sphinx</h2>
-  <p>
-    Sphinx is available as an <a
-    href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy-install</a>able
-    package on the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
-    Index</a>.
-  </p>
-  
-{% endblock %}

doc/.templates/indexsidebar.html

-<h3>Download</h3>
-
-<p>Get Sphinx from the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
-Index</a>.</p>
-
-<h3>Questions? Suggestions?</h3>
-
-<p>Send them to <nobr>&lt;georg at python org&gt;</nobr>, or come to the
-<tt>#python-docs</tt> channel on FreeNode.</p>

doc/.templates/layout.html

-{% extends "!layout.html" %}
-
-{% block rootrellink %}
-        <li><a href="{{ pathto('index') }}">Sphinx home </a> |&nbsp;</li>
-        <li><a href="{{ pathto('contents') }}">Documentation </a> &raquo;</li>
-{% endblock %}
-
-{% block beforerelbar %}
-<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
-<img src="{{ pathto("static/sphinx.png", 1) }}">
-</div>
-{% endblock %}
-
-{# put the sidebar before the body #}
-{% block sidebar1 %}{{ sidebar() }}{% endblock %}
-{% block sidebar2 %}{% endblock %}
 SPHINXBUILD  = python ../sphinx-build.py
 PAPER        =
 
-ALLSPHINXOPTS = -d .build/doctrees -D latex_paper_size=$(PAPER) \
+ALLSPHINXOPTS = -d _build/doctrees -D latex_paper_size=$(PAPER) \
                 $(SPHINXOPTS) .
 
 .PHONY: help clean html web htmlhelp latex changes linkcheck
 	@echo "  linkcheck to check all external links for integrity"
 
 clean:
-	-rm -rf .build/*
+	-rm -rf _build/*
 
 html:
-	mkdir -p .build/html .build/doctrees
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+	mkdir -p _build/html _build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
 	@echo
-	@echo "Build finished. The HTML pages are in .build/html."
+	@echo "Build finished. The HTML pages are in _build/html."
 
 web:
-	mkdir -p .build/web .build/doctrees
-	$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) .build/web
+	mkdir -p _build/web _build/doctrees
+	$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) _build/web
 	@echo
 	@echo "Build finished; now you can run"
-	@echo "  python -m sphinx.web .build/web"
+	@echo "  python -m sphinx.web _build/web"
 	@echo "to start the server."
 
 htmlhelp:
-	mkdir -p .build/htmlhelp .build/doctrees
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/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."
+	      ".hhp project file in _build/htmlhelp."
 
 latex:
-	mkdir -p .build/latex .build/doctrees
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/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 "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
+	mkdir -p _build/changes _build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
 	@echo
-	@echo "The overview file is in .build/changes."
+	@echo "The overview file is in _build/changes."
 
 linkcheck:
-	mkdir -p .build/linkcheck .build/doctrees
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/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."
+	      "or in _build/linkcheck/output.txt."
 
 doctest:
-	mkdir -p .build/doctest .build/doctrees
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .build/doctest
+	mkdir -p _build/doctest _build/doctrees
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
Added
New image

doc/_templates/index.html

+{% extends "layout.html" %}
+{% set title = 'Overview' %}
+{% block body %}
+  <p style="background-color: #fcc; font-size: large; border: 1px solid #f00; padding: 10px;">
+    <b>Attention:</b> this is a preview. Sphinx is not released yet on PyPI,
+    and the contents of this documentation are subject to change.
+  </p>
+
+  <h1>Welcome</h1>
+
+  <p>
+    Sphinx is a tool that makes it easy to create intelligent and beautiful
+    documentation for Python projects, written by Georg Brandl.  It was
+    originally created to translate <a href="http://docs.python.org/dev/">the
+    new Python documentation</a>, but has now been cleaned up in the hope that
+    it will be useful to many other projects.  (Of course, this site is also
+    created from reStructuredText sources using Sphinx!)
+
+  </p>
+  <p>
+    Although it is still under constant development, the following features are
+    already present, work fine and can be seen &#8220;in action&#8221; in the
+    Python docs:
+  </p>
+  <ul>
+    <li><b>Output formats:</b> HTML (including Windows HTML Help) and LaTeX, for
+    printable PDF versions</li>
+    <li><b>Extensive cross-references:</b> semantic markup and automatic links
+    for functions, classes, glossary terms and similar pieces of information</li>
+    <li><b>Hierarchical structure:</b> easy definition of a document tree, with
+    automatic links to siblings, parents and children</li>
+    <li><b>Automatic indices:</b> general index as well as a module index</li>
+    <li><b>Code handling:</b> automatic highlighting using the <a
+    href="http://pygments.org">Pygments</a> highlighter</li>
+  </ul>
+  <p>
+    Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a>
+    as its markup language, and many of its strengths come from the power and
+    straightforwardness of reStructuredText and its parsing and translating
+    suite, the <a href="http://docutils.sf.net/">Docutils</a>.
+  </p>
+
+  <h2>Documentation</h2>
+  <table class="contentstable" align="center" style="margin-left: 30px"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br>
+         <span class="linkdescr">for a complete overview</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br>
+         <span class="linkdescr">search the documentation</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br>
+         <span class="linkdescr">all functions, classes, terms</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Module Index</a><br>
+         <span class="linkdescr">quick access to all documented modules</span></p>
+    </td></tr>
+  </table>
+
+  <h2>Get Sphinx</h2>
+  <p>
+    Sphinx is available as an <a
+    href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy-install</a>able
+    package on the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
+    Index</a>.
+  </p>
+  
+{% endblock %}

doc/_templates/indexsidebar.html

+<h3>Download</h3>
+
+<p>Get Sphinx from the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
+Index</a>.</p>
+
+<h3>Questions? Suggestions?</h3>
+
+<p>Send them to <nobr>&lt;georg at python org&gt;</nobr>, or come to the
+<tt>#python-docs</tt> channel on FreeNode.</p>

doc/_templates/layout.html

+{% extends "!layout.html" %}
+
+{% block rootrellink %}
+        <li><a href="{{ pathto('index') }}">Sphinx home </a> |&nbsp;</li>
+        <li><a href="{{ pathto('contents') }}">Documentation </a> &raquo;</li>
+{% endblock %}
+
+{% block beforerelbar %}
+<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
+<img src="{{ pathto("static/sphinx.png", 1) }}">
+</div>
+{% endblock %}
+
+{# put the sidebar before the body #}
+{% block sidebar1 %}{{ sidebar() }}{% endblock %}
+{% block sidebar2 %}{% endblock %}
 extensions = ['ext', 'sphinx.ext.autodoc', 'sphinx.ext.doctest']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 # 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']
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.