Rick Copeland avatar Rick Copeland committed 31460fd

Update docs to replace fastpt with kajiki globally

Comments (0)

Files changed (6)

 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
-upload: html
-	scp -r _build/html/* pythonisito.com:pythonisito.com/fastpt
+# upload: html
+# 	scp -r _build/html/* pythonisito.com:pythonisito.com/kajiki
 
 clean:
 	-rm -rf $(BUILDDIR)/*
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FastPt.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Kajiki.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FastPt.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Kajiki.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/FastPt"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FastPt"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Kajiki"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Kajiki"
 	@echo "# devhelp"
 
 epub:
 # -*- coding: utf-8 -*-
 #
-# FastPt documentation build configuration file, created by
+# Kajiki documentation build configuration file, created by
 # sphinx-quickstart on Wed Jul  7 22:31:03 2010.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 master_doc = 'index'
 
 # General information about the project.
-project = u'FastPt'
+project = u'Kajiki'
 copyright = u'2010, Rick Copeland'
 
 # The version info for the project you're documenting, acts as replacement for
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'FastPtdoc'
+htmlhelp_basename = 'Kajikidoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'FastPt.tex', u'FastPt Documentation',
+  ('index', 'Kajiki.tex', u'Kajiki Documentation',
    u'Rick Copeland', 'manual'),
 ]
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'fastpt', u'FastPt Documentation',
+    ('index', 'kajiki', u'Kajiki Documentation',
      [u'Rick Copeland'], 1)
 ]
-.. FastPt documentation master file, created by
+.. Kajiki documentation master file, created by
    sphinx-quickstart on Wed Jul  7 22:31:03 2010.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to FastPt's documentation!
+Welcome to Kajiki's documentation!
 ==================================
 
-* Code Development / Issue Tracker on BitBucket_ (currently)
-* Developer list is at fastpt-dev_ 
-* Commits list is at fastpt-commits_
+* Code Development / Issue Tracker / Forums on SourceForge_
 
 Contents:
 
 * :ref:`modindex`
 * :ref:`search`
 
-.. _BitBucket: http://bitbucket.org/rick446/fastpt
-.. _fastpt-dev: http://groups.google.com/group/fastpt-dev
-.. _fastpt-commits: http://groups.google.com/group/fastpt-commits
+.. _SourceForge: http://sourceforge.net/p/kajiki/

docs/migrating_from_genshi.rst

 Migrating from Genshi
 ======================================
 
-FastPt uses syntax derived from the syntax of Genshi.  In particular, the
+Kajiki uses syntax derived from the syntax of Genshi.  In particular, the
 following directives are supported, with semantics intended to be nearly identical to
 those of Genshi_.
 
  * `py:strip`
  * `xi:include`
 
-Note that, in particular, `py:match` is not supported.  In addition, FastPt
+Note that, in particular, `py:match` is not supported.  In addition, Kajiki
 supports the following additional directives: 
 
  * `py:include` - same semantics as `xi:include`, use if you don't like lots of
 directives that is `xi:included` into all your page templates, the following
 steps should suffice:
 
- * You may need to rewrite some of our `xi:include` directives to use FastPt's
+ * You may need to rewrite some of our `xi:include` directives to use Kajiki's
    module naming system and relative imports.
  * In a simple case where you have only a few `py:match` directives, all of which
    are in a `master.html` template that is being included from child templates,
    :linenos:
    :language: html
 
-In order to perform our fastpt migration, we begin by creating two empty
+In order to perform our kajiki migration, we begin by creating two empty
 templates.  The first one will replace our `master.html`, and we will call it
 `layout.html`:
 
    :language: html
    :lines: 10
 
-can be replaced by a similarly-named slot in the child document `index_fastpt.html`:
+can be replaced by a similarly-named slot in the child document `index_kajiki.html`:
 
-.. literalinclude:: include/index_fastpt.html
+.. literalinclude:: include/index_kajiki.html
    :linenos:
    :language: html
    :lines: 1-6, 9-10
    :language: html
    :lines:  18
 
-can be replaced in `include/index_fastpt.html` with:
+can be replaced in `include/index_kajiki.html` with:
   
-.. literalinclude:: include/index_fastpt.html
+.. literalinclude:: include/index_kajiki.html
    :linenos:
    :language: html
    :lines: 12-15

docs/text-templates.rst

 ==================================
-FastPt Text Templates
+Kajiki Text Templates
 ==================================
 
 Basic Expressions
 Control Flow
 ============
 
-FastPt provides several tags that affect the rendering of a template.  The
+Kajiki provides several tags that affect the rendering of a template.  The
 following template "control_flow.txt" illustrates:
 
 .. code-block:: none
 Functions and Imports
 ====================================
 
-FastPt provides for code reuse via the %def and %import directives.  First, let's
+Kajiki provides for code reuse via the %def and %import directives.  First, let's
 see %def in action in "simple_function.txt":
 
 .. code-block:: none
 Inheritance
 ==============
 
-FastPt supports a concept of inheritance whereby child templates can extend
+Kajiki supports a concept of inheritance whereby child templates can extend
 parent templates, replacing their methods and "blocks" (to be defined below).
 For instance, consider the following template "parent.txt":
 

docs/xml-templates.rst

 ==================================
-FastPt XML Templates
+Kajiki XML Templates
 ==================================
 
 Tags
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.