Skip to content
This repository has been archived by the owner on Jan 21, 2022. It is now read-only.

Commit

Permalink
Updated docs and buildout
Browse files Browse the repository at this point in the history
  • Loading branch information
Brendan W. McAdams committed Dec 9, 2010
1 parent d8ed9dc commit 7c7340e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
8 changes: 4 additions & 4 deletions tutorial_src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CasbahMongoDBScalaToolkitTutorial.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CasbahTutorial.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CasbahMongoDBScalaToolkitTutorial.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CasbahTutorial.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/CasbahMongoDBScalaToolkitTutorial"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CasbahMongoDBScalaToolkitTutorial"
@echo "# mkdir -p $$HOME/.local/share/devhelp/CasbahTutorial"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CasbahTutorial"
@echo "# devhelp"

epub:
Expand Down
4 changes: 2 additions & 2 deletions tutorial_src/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -40,7 +40,7 @@
master_doc = 'index'

# General information about the project.
project = u'Casbah (MongoDB Scala Toolkit) Documentation'
project = u'Casbah (MongoDB + Scala Toolkit Documentation'
copyright = u'2010, 2011 10gen, Inc.'

# The version info for the project you're documenting, acts as replacement for
Expand Down
8 changes: 6 additions & 2 deletions tutorial_src/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ Welcome to the Casbah Documentation. Casbah is a Scala toolkit for MongoDB---We

Casbah's approach is intended to add fluid, Scala-friendly syntax on top of MongoDB and handle conversions of common types. If you try to save a Scala List or Seq to MongoDB, we automatically convert it to a type the Java driver can serialize. If you read a Java type, we convert it to a comparable Scala type before it hits your code. All of this is intended to let you focus on writing the best possible Scala code using Scala idioms. A great deal of effort is put into providing you the functional and implicit conversion tools you've come to expect from Scala, with the power and flexibility of MongoDB.

The `ScalaDocs for Casbah <http://api.mongodb.org/scala/casbah/>`_ along with SXR cross referenced source are available at the `MongoDB API site <http://api.mongodb.org>`_.

The `ScalaDocs for Casbah <http://api.mongodb.org/scala/casbah/scaladoc/>`_ along with SXR cross referenced source are available at the `MongoDB API site <http://api.mongodb.org>`_.

You may also download this tutorial in other formats.

* `ePub <http://api.mongodb.org/scala/casbah/CasbahTutorial.epub>`_
* `PDF <http://api.mongodb.org/scala/casbah/CasbahTutorial.pdf>`_

.. toctree::
:maxdepth: 3

Expand Down

0 comments on commit 7c7340e

Please sign in to comment.