fork docs

docs/.gitignore

@@ -1 +1,2 @@
 _build/
+_themes/

docs/api.rst

@@ -1,9 +1,9 @@
 .. _api_catalog_section:
 
-:mod:`repoze.catalog.catalog`
------------------------------
+:mod:`hypatia.catalog`
+----------------------
 
-.. automodule:: repoze.catalog.catalog
+.. automodule:: hypatia.catalog
 
   .. autoclass:: Catalog
      :members:
@@ -18,11 +18,23 @@
 
         Retrieve an index or return failobj.
 
+     .. automethod:: clear_indexes
 
-:mod:`repoze.catalog.query`
----------------------------
+     .. automethod:: index_doc
 
-.. module:: repoze.catalog.query
+     .. automethod:: unindex_doc
+
+     .. automethod:: reindex_doc
+
+  .. autoclass:: CatalogQuery
+     :members:
+
+     .. automethod:: __call__
+
+:mod:`hypatia.query`
+--------------------
+
+.. module:: hypatia.query
 
 Comparators
 ~~~~~~~~~~~
@@ -75,59 +87,49 @@ Other Helpers
 
 .. _api_fieldindex_section:
 
-:mod:`repoze.catalog.indexes.field`
------------------------------------
+:mod:`hypatia.field`
+--------------------
 
-.. automodule:: repoze.catalog.indexes.field
+.. automodule:: hypatia.field
 
-   .. autoclass:: CatalogFieldIndex
+   .. autoclass:: FieldIndex
       :members:
 
 .. _api_keywordindex_section:
 
-:mod:`repoze.catalog.indexes.keyword`
+:mod:`hypatia.keyword`
 -------------------------------------
 
-.. automodule:: repoze.catalog.indexes.keyword
+.. automodule:: hypatia.keyword
 
-   .. autoclass:: CatalogKeywordIndex
+   .. autoclass:: KeywordIndex
       :members:
 
 .. _api_textindex_section:
 
-:mod:`repoze.catalog.indexes.text`
+:mod:`hypatia.text`
 -----------------------------------
 
-.. automodule:: repoze.catalog.indexes.text
+.. automodule:: hypatia.text
 
-   .. autoclass:: CatalogTextIndex
+   .. autoclass:: TextIndex
       :members:
 
 .. _api_facetindex_section:
 
-:mod:`repoze.catalog.indexes.facet`
+:mod:`hypatia.facet`
 -------------------------------------
 
-.. automodule:: repoze.catalog.indexes.facet
+.. automodule:: hypatia.facet
 
-   .. autoclass:: CatalogFacetIndex
+   .. autoclass:: FacetIndex
       :members:
 
-:mod:`repoze.catalog.indexes.path`
+:mod:`hypatia.path`
 ----------------------------------
 
-.. automodule:: repoze.catalog.indexes.path
+.. automodule:: hypatia.path
 
-   .. autoclass:: CatalogPathIndex
+   .. autoclass:: PathIndex
       :members:
 
-.. _api_document_section:
-
-:mod:`repoze.catalog.document`
-------------------------------
-
-.. automodule:: repoze.catalog.document
-
-  .. autoclass:: DocumentMap
-     :members:
-

docs/changes.rst

@@ -1,4 +1,4 @@
-:mod:`repoze.catalog` Change History
-====================================
+:mod:`hypatia` Change History
+=============================
 
 .. literalinclude:: ../CHANGES.txt

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# repoze.catalog documentation build configuration file
+# hypatia documentation build configuration file
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -16,18 +16,25 @@
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 
+# Add and use Pylons theme
 if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
-    parent = os.path.dirname(os.path.dirname(__file__))
-    sys.path.append(os.path.abspath(parent))
-    wd = os.getcwd()
-    os.chdir(parent)
-    os.system('%s setup.py test -q' % sys.executable)
-    os.chdir(wd)
+    from subprocess import call, Popen, PIPE
 
-    for item in os.listdir(parent):
-        if item.endswith('.egg'):
-            sys.path.append(os.path.join(parent, item))
+    p = Popen('which git', shell=True, stdout=PIPE)
+    git = p.stdout.read().strip()
+    cwd = os.getcwd()
+    _themes = os.path.join(cwd, '_themes')
 
+    if not os.path.isdir(_themes):
+        call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git',
+                '_themes'])
+    else:
+        os.chdir(_themes)
+        call([git, 'checkout', 'master'])
+        call([git, 'pull'])
+        os.chdir(cwd)
+
+    sys.path.append(os.path.abspath('_themes'))
 
 # General configuration
 # ---------------------
@@ -46,14 +53,14 @@
 master_doc = 'index'
 
 # General substitutions.
-project = 'repoze.catalog'
-copyright = '2008-2012, Agendaless Consulting'
+project = 'hypatia'
+copyright = '2008-2012, Zope Foundation and Contributors'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '0.8.2'
+version = '0.1a1'
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -70,6 +77,8 @@
 # for source files.
 #exclude_dirs = []
 
+exclude_patterns = ['_themes/README.rst',]
+
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 
@@ -91,10 +100,18 @@
 # Options for HTML output
 # -----------------------
 
+# Add and use Pylons theme
+html_theme_path = ['_themes']
+html_theme = 'pylons'
+html_theme_options = dict(
+    github_url='https://github.com/Pylons/hypatia',
+#    in_progress='true'
+    )
+
 # 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.
-html_style = 'repoze.css'
+#html_style = 'repoze.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -105,7 +122,7 @@
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
-html_logo = '.static/logo_hi.gif'
+#html_logo = '.static/logo_hi.gif'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -115,7 +132,7 @@
 # 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.
@@ -153,7 +170,7 @@
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'repozecatalogdoc'
+htmlhelp_basename = 'hypatiadoc'
 
 
 # Options for LaTeX output
@@ -168,7 +185,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
-  ('index', 'repozecatalog.tex', 'repoze.catalog Documentation', 'Agendaless Consulting', 'manual'),
+  ('index', 'hypatia.tex', 'hypatia Documentation', 'Agendaless Consulting', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of