Skip to content

Commit

Permalink
fork docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mcdonc
mcdonc committed Jun 20, 2012
1 parent e9fd618 commit 63e8696
Show file tree
Hide file tree
Showing 13 changed files with 139 additions and 1,062 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
View file
Original file line number Original file line Diff line number Diff line change
@@ -1 +1,2 @@
_build/ _build/
_themes/
66 changes: 34 additions & 32 deletions docs/api.rst
View file
Original file line number Original file line Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _api_catalog_section: .. _api_catalog_section:


:mod:`repoze.catalog.catalog` :mod:`hypatia.catalog`
----------------------------- ----------------------


.. automodule:: repoze.catalog.catalog .. automodule:: hypatia.catalog


.. autoclass:: Catalog .. autoclass:: Catalog
:members: :members:
Expand All @@ -18,11 +18,23 @@


Retrieve an index or return failobj. 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 Comparators
~~~~~~~~~~~ ~~~~~~~~~~~
Expand Down Expand Up @@ -75,59 +87,49 @@ Other Helpers


.. _api_fieldindex_section: .. _api_fieldindex_section:


:mod:`repoze.catalog.indexes.field` :mod:`hypatia.field`
----------------------------------- --------------------


.. automodule:: repoze.catalog.indexes.field .. automodule:: hypatia.field


.. autoclass:: CatalogFieldIndex .. autoclass:: FieldIndex
:members: :members:


.. _api_keywordindex_section: .. _api_keywordindex_section:


:mod:`repoze.catalog.indexes.keyword` :mod:`hypatia.keyword`
------------------------------------- -------------------------------------


.. automodule:: repoze.catalog.indexes.keyword .. automodule:: hypatia.keyword


.. autoclass:: CatalogKeywordIndex .. autoclass:: KeywordIndex
:members: :members:


.. _api_textindex_section: .. _api_textindex_section:


:mod:`repoze.catalog.indexes.text` :mod:`hypatia.text`
----------------------------------- -----------------------------------


.. automodule:: repoze.catalog.indexes.text .. automodule:: hypatia.text


.. autoclass:: CatalogTextIndex .. autoclass:: TextIndex
:members: :members:


.. _api_facetindex_section: .. _api_facetindex_section:


:mod:`repoze.catalog.indexes.facet` :mod:`hypatia.facet`
------------------------------------- -------------------------------------


.. automodule:: repoze.catalog.indexes.facet .. automodule:: hypatia.facet


.. autoclass:: CatalogFacetIndex .. autoclass:: FacetIndex
:members: :members:


:mod:`repoze.catalog.indexes.path` :mod:`hypatia.path`
---------------------------------- ----------------------------------


.. automodule:: repoze.catalog.indexes.path .. automodule:: hypatia.path


.. autoclass:: CatalogPathIndex .. autoclass:: PathIndex
:members: :members:


.. _api_document_section:

:mod:`repoze.catalog.document`
------------------------------

.. automodule:: repoze.catalog.document

.. autoclass:: DocumentMap
:members:

4 changes: 2 additions & 2 deletions docs/changes.rst
View file
Original file line number Original file line Diff line number Diff line change
@@ -1,4 +1,4 @@
:mod:`repoze.catalog` Change History :mod:`hypatia` Change History
==================================== =============================


.. literalinclude:: ../CHANGES.txt .. literalinclude:: ../CHANGES.txt
40 changes: 0 additions & 40 deletions docs/code/index_attributes.py
View file

This file was deleted.

46 changes: 0 additions & 46 deletions docs/code/index_callbacks.py
View file

This file was deleted.

53 changes: 35 additions & 18 deletions docs/conf.py
View file
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*- # -*- 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. # This file is execfile()d with the current directory set to its containing dir.
# #
Expand All @@ -16,18 +16,25 @@
# is relative to the documentation root, use os.path.abspath to make it # is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here. # absolute, like shown here.


# Add and use Pylons theme
if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
parent = os.path.dirname(os.path.dirname(__file__)) from subprocess import call, Popen, PIPE
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)


for item in os.listdir(parent): p = Popen('which git', shell=True, stdout=PIPE)
if item.endswith('.egg'): git = p.stdout.read().strip()
sys.path.append(os.path.join(parent, item)) 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 # General configuration
# --------------------- # ---------------------
Expand All @@ -46,14 +53,14 @@
master_doc = 'index' master_doc = 'index'


# General substitutions. # General substitutions.
project = 'repoze.catalog' project = 'hypatia'
copyright = '2008-2012, Agendaless Consulting' copyright = '2008-2012, Zope Foundation and Contributors'


# The default replacements for |version| and |release|, also used in various # The default replacements for |version| and |release|, also used in various
# other places throughout the built documents. # other places throughout the built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.8.2' version = '0.1a1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = version release = version


Expand All @@ -70,6 +77,8 @@
# for source files. # for source files.
#exclude_dirs = [] #exclude_dirs = []


exclude_patterns = ['_themes/README.rst',]

# The reST default role (used for this markup: `text`) to use for all documents. # The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None #default_role = None


Expand All @@ -91,10 +100,18 @@
# Options for HTML output # 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 # 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 # must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path. # 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 # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
Expand All @@ -105,7 +122,7 @@


# The name of an image file (within the static path) to place at the top of # The name of an image file (within the static path) to place at the top of
# the sidebar. # 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 # 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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand All @@ -115,7 +132,7 @@
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
Expand Down Expand Up @@ -153,7 +170,7 @@
#html_file_suffix = '' #html_file_suffix = ''


# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'repozecatalogdoc' htmlhelp_basename = 'hypatiadoc'




# Options for LaTeX output # Options for LaTeX output
Expand All @@ -168,7 +185,7 @@
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]). # (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [ 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 # The name of an image file (relative to this directory) to place at the top of
Expand Down
Loading

0 comments on commit 63e8696

Please sign in to comment.