[Checkins] SVN: buildout-website/trunk/ Minor cleanup re a few mispelled words, a new directory to hold Python
Jeff Rush
jrush at taupro.com
Mon Mar 30 12:40:00 EDT 2009
Log message for revision 98605:
Minor cleanup re a few mispelled words, a new directory to hold Python
extensions to Sphinx, a glossary page to receive definitions of terms specific
to Buildout.
Changed:
_U buildout-website/trunk/
U buildout-website/trunk/README
A buildout-website/trunk/extensions/
U buildout-website/trunk/source/_static/default.css
U buildout-website/trunk/source/_templates/index.html
U buildout-website/trunk/source/conf.py
U buildout-website/trunk/source/docs/index.rst
A buildout-website/trunk/source/glossary.rst
-=-
Property changes on: buildout-website/trunk
___________________________________________________________________
Modified: svn:ignore
- build
develop-eggs
bin
parts
.installed.cfg
+ build
eggs
develop-eggs
bin
parts
.installed.cfg
Modified: buildout-website/trunk/README
===================================================================
--- buildout-website/trunk/README 2009-03-30 15:55:04 UTC (rev 98604)
+++ buildout-website/trunk/README 2009-03-30 16:40:00 UTC (rev 98605)
@@ -22,7 +22,63 @@
directive and Sphinx will emit a warning at document build time if this is
not so.
+For the overall site, there are two indices; a general index and a module
+index. The general index is populated with entries from modules, all
+index-generating description units, and from index directives. The module
+index contains one entry per module directive.
+
+
+Useful ReStructuredText Roles
+=============================
+
+ :envvar:`somevar`
+
+ Generates an index entry that links back to the one or more occurrences of
+ this role.
+
+ :term:`someword`
+
+ Generates a link from where this role occurs to its definition in the
+ sources/glossary.rst document.
+
+ :file:`somefilename`
+
+ Formats the name in a special format suitable to filenames.
+
+ :command:`somecommand`
+
+ Formats the commandname in a special format suitable to command names.
+
+ :program:`someprogram`
+
+ Formats the programname in a special format suitable to program names.
+
+ :pep:`number`
+
+ Generates an external link to the appropriate PEP document.
+
+ :rfc:`number`
+
+ Generates an external link to the appropriate RFC document.
+
+
+Useful ReStructuredText Directives
+==================================
+
+ .. sourcecode:: python
+
+ Some python code
+
+ .. sourcecode:: none
+
+ non-highlighted code
+
+ .. literalinclude:: somefile.py
+ :language: python
+ :linenos:
+
+
HOW DO I CONFIGURE THE CONVERSION PROCESS?
==========================================
@@ -49,9 +105,10 @@
=======================================
- Jeff Rush
- - Baiju
+p - Baiju
- ???
+
Thanks
------
Modified: buildout-website/trunk/source/_static/default.css
===================================================================
--- buildout-website/trunk/source/_static/default.css 2009-03-30 15:55:04 UTC (rev 98604)
+++ buildout-website/trunk/source/_static/default.css 2009-03-30 16:40:00 UTC (rev 98605)
@@ -236,20 +236,20 @@
text-align: center;
}
-ul.mainlinks li a span.linktitle {
+ul.mainlinks li a span.linktitle {
font-size: 22px;
font-weight: bold;
}
-ul.mainlinks li a span.linkdesc {
+ul.mainlinks li a span.linkdesc {
font-size: 10px;
display: block;
}
-div.testmnonials {
+div.testimonials {
width: 100%;
}
-div.testmnonials p {
+div.testimonials p {
text-align: center;
-}
\ No newline at end of file
+}
Modified: buildout-website/trunk/source/_templates/index.html
===================================================================
--- buildout-website/trunk/source/_templates/index.html 2009-03-30 15:55:04 UTC (rev 98604)
+++ buildout-website/trunk/source/_templates/index.html 2009-03-30 16:40:00 UTC (rev 98605)
@@ -73,7 +73,7 @@
<div class="clearer"></div>
- <div class="testmnonials">
+ <div class="testimonials">
<hr />
<p>"While not directly aiming to solve world peace, it perhaps will play
a role in the future, as people will be less angry about application
@@ -125,4 +125,3 @@
</body>
</html>
-
Modified: buildout-website/trunk/source/conf.py
===================================================================
--- buildout-website/trunk/source/conf.py 2009-03-30 15:55:04 UTC (rev 98604)
+++ buildout-website/trunk/source/conf.py 2009-03-30 16:40:00 UTC (rev 98605)
@@ -14,14 +14,14 @@
import sys
# If your extensions are in another directory, add it here.
-#sys.path.append('some/directory')
+sys.path.append('extensions')
# General configuration
# ---------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#extensions = []
+#JEFF extensions = ['embeddedvideo', 'recipes']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -71,6 +71,8 @@
# Options for HTML output
# -----------------------
+#JEFF html_translator_class = 'embeddedvideo.MyHTMLTranslator'
+
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
@@ -97,7 +99,9 @@
# Additional templates that should be rendered to pages, maps page names to
# template names.
-html_additional_pages = {'index': 'index.html'}
+html_additional_pages = {
+ 'index': 'index.html' # we like a customized frontpage
+ }
# If false, no module index is generated.
#html_use_modindex = True
Modified: buildout-website/trunk/source/docs/index.rst
===================================================================
--- buildout-website/trunk/source/docs/index.rst 2009-03-30 15:55:04 UTC (rev 98604)
+++ buildout-website/trunk/source/docs/index.rst 2009-03-30 16:40:00 UTC (rev 98605)
@@ -1,11 +1,10 @@
Buildout Documentation
======================
-
Using Buildout
--------------
-`Using Buildout <using.html>`_ briefly describes the usage of
+Using Buildout <using.html>`_ briefly describes the usage of
Buildout from the perspective of an end user or integrator.
Tutorial
@@ -24,10 +23,9 @@
List of Recipes
---------------
-If you are looking for Buildout recipes, you can find some `here
-<recipelist.html>`_ .
+A `list of the more commonly used recipes <recipelist.html>` used with Buildout.
Links
-----
-You can see few links related to Buildout `here <links.html>`_.
+A `collection of links related to Buildout <link.html>`.
Added: buildout-website/trunk/source/glossary.rst
===================================================================
--- buildout-website/trunk/source/glossary.rst (rev 0)
+++ buildout-website/trunk/source/glossary.rst 2009-03-30 16:40:00 UTC (rev 98605)
@@ -0,0 +1,33 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+ builder
+ A class (inheriting from :class:`~sphinx.builder.Builder`) that takes
+ parsed documents and performs an action on them. Normally, builders
+ translate the documents to an output format, but it is also possible to
+ use the builder builders that e.g. check for broken links in the
+ documentation, or build coverage information.
+
+ configuration directory
+ The directory containing :file:`conf.py`. By default, this is the same
+ as the :term:`source directory`, but can be set differently with the
+ **-c** command-line option.
+
+ description unit
+ The basic building block of Sphinx documentation. Every "description
+ directive" creates such a unit; and most units can be cross-referenced
+ to.
+
+ environment
+ A structure where information about all documents under the root is
+ saved, and used for cross-referencing. The environment is pickled after
+ the parsing stage, so that successive runs only need to read and parse
+ new and changed documents.
+
+ source directory
+ The directory which, including its subdirectories, contains all source
+ files for one Sphinx project.
Property changes on: buildout-website/trunk/source/glossary.rst
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: svn:keywords
+ Author Date Id Revision
Added: svn:eol-style
+ native
More information about the Checkins
mailing list