Permalink
Browse files

Cleaning up + Refactoring docs

  • Loading branch information...
Brendan W. McAdams
Brendan W. McAdams committed Nov 5, 2012
1 parent e3f646e commit 3c00e31a3b5bcb636852d36880e903be776fd00c
Showing with 1,957 additions and 280 deletions.
  1. +6 −0 build.sbt
  2. +1 −0 project/plugins.sbt
  3. +1 −0 src/sphinx
  4. 0 tutorial_src/.templates/.mongodb
  5. +7 −7 tutorial_src/source/conf.py
  6. +5 −6 tutorial_src/source/index.rst
  7. BIN tutorial_src/source/logo-mongodb.png
  8. +29 −267 tutorial_src/source/setting_up.rst
  9. +5 −0 tutorial_src/source/themes/docs.mongodb.org/.htaccess
  10. +31 −0 tutorial_src/source/themes/docs.mongodb.org/10gen-gpg-key.asc
  11. +28 −0 tutorial_src/source/themes/docs.mongodb.org/10gen-security-gpg-key.asc
  12. +67 −0 tutorial_src/source/themes/docs.mongodb.org/index.html
  13. +14 −0 tutorial_src/source/themes/docs.mongodb.org/osd.xml
  14. +24 −0 tutorial_src/source/themes/epub_mongodb/epub-cover.html
  15. +19 −0 tutorial_src/source/themes/epub_mongodb/layout.html
  16. +502 −0 tutorial_src/source/themes/epub_mongodb/static/epub.css
  17. +4 −0 tutorial_src/source/themes/epub_mongodb/theme.conf
  18. +9 −0 tutorial_src/source/themes/mongodb/globaltoc.html
  19. +267 −0 tutorial_src/source/themes/mongodb/layout.html
  20. +10 −0 tutorial_src/source/themes/mongodb/localtoc.html
  21. +13 −0 tutorial_src/source/themes/mongodb/page.html
  22. +18 −0 tutorial_src/source/themes/mongodb/pagenav.html
  23. +58 −0 tutorial_src/source/themes/mongodb/search.html
  24. +16 −0 tutorial_src/source/themes/mongodb/sourcelink.html
  25. +689 −0 tutorial_src/source/themes/mongodb/static/mongodb-docs.css_t
  26. +46 −0 tutorial_src/source/themes/mongodb/static/reset.css
  27. +10 −0 tutorial_src/source/themes/mongodb/theme.conf
  28. +78 −0 tutorial_src/source/themes/mongodb/wikisidebar.html
View
@@ -0,0 +1,6 @@
+site.settings
+
+site.includeScaladoc()
+
+site.sphinxSupport()
+
View
@@ -0,0 +1 @@
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.6.0")
View
No changes.
@@ -29,7 +29,7 @@
'sphinx.ext.extlinks']
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['.templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -41,17 +41,17 @@
master_doc = 'index'
# General information about the project.
-project = u'Casbah (MongoDB + Scala Toolkit Documentation'
-copyright = u'2010, 2011 10gen, Inc.'
+project = u'Casbah (MongoDB + Scala Toolkit) Documentation'
+copyright = u'2010-2013 10gen, Inc.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '2.1'
+version = '2.5'
# The full version, including alpha/beta/rc tags.
-release = '2.1.5'
+release = '2.5.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -93,15 +93,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'nature'
+html_theme = 'mongodb'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@@ -15,20 +15,19 @@ Casbah provides improved interfaces to GridFS, Map/Reduce and the core Mongo API
With version 2.0, Casbah has become an official MongoDB project and will continue to improve the interaction of Scala + MongoDB. Casbah aims to remain fully compatible with the existing Java driver---it does not talk to MongoDB directly, preferring to wrap the Java code. This means you shouldn't see any wildly unexpected behavior from the underlying Mongo interfaces when a data bug is fixed.
-The `ScalaDocs for Casbah <http://api.mongodb.org/scala/casbah/2.1.5.0/scaladoc/>`_ 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>`_.
-.. TODO - links to prior releases?5.0
You may also download this documentation in other formats.
- * `ePub <http://api.mongodb.org/scala/casbah/2.1.5.0/CasbahDocumentation.epub>`_
- * `PDF <http://api.mongodb.org/scala/casbah/2.1.5.0/CasbahDocumentation.pdf>`_
+ * `ePub <http://api.mongodb.org/scala/casbah/CasbahDocumentation.epub>`_
+ * `PDF <http://api.mongodb.org/scala/casbah/CasbahDocumentation.pdf>`_
.. toctree::
:maxdepth: 3
:numbered:
- API Docs <http://api.mongodb.org/scala/casbah/2.1.5.0/scaladoc/>
+ API Docs <http://api.mongodb.org/scala/casbah/scaladoc/>
setting_up
tutorial
@@ -37,7 +36,7 @@ You may also download this documentation in other formats.
.. Indices and tables
.. ==================
..
-.. * `API Docs <http://api.mongodb.org/scala/casbah/2.1.5.0/scaladoc/>`_
+.. * `API Docs <http://api.mongodb.org/scala/casbah//scaladoc/>`_
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
Binary file not shown.

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,5 @@
+# Note: this must be manually copied, sphinx does not process it
+ErrorDocument 401 /manual/meta/401.html
+ErrorDocument 403 /manual/meta/403.html
+ErrorDocument 404 /manual/meta/404.html
+ErrorDocument 410 /manual/meta/410.html
@@ -0,0 +1,31 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1.4.10 (Darwin)
+
+
+mQENBEtsQe8BCACm5G0/ei0IxyjVEp6EEtbEbWK1Q4dKaONtiCODwB8di+L8tlUd
+Ra5QYxeyV90C+dqdh34o79enXxT6idHfYYqDdob2/kAPE6vFi4sLmrWIVGCRY++7
+RPclZuezPm1sxG1TRAYEsW0VZUE9ofdoQ8xlUZDyn2BSjG8OCT2e4orRg1pHgzw2
+n3hnWqJNuJS4jxcRJOxI049THIGUtqBfF8bQoZw8C3Wg/R6pGghUfNjpA6uF9KAH
+gnqrC0swZ1/vwIJt9fnvAlzkqLrssYtKH0rMdn5n4g5tJLqY5q/NruHMq2rhoy3r
+4MC1w8GTbP7qR83wAyaLJ7xACOKqxB3SrDFJABEBAAG0I1JpY2hhcmQgS3JldXRl
+ciA8cmljaGFyZEAxMGdlbi5jb20+iQE4BBMBAgAiBQJLbEHvAhsDBgsJCAcDAgYV
+CAIJCgsEFgIDAQIeAQIXgAAKCRCey+xGfwzrEGXbB/4nrmf/2rEnztRelmup3duI
+eepzEtw1cv3uHg2oZXGS6S7o5Fsk+amngaWelWKfkSw5La7aH5vL4tKFKUfuaME1
+avInDIU/0IEs8jLrdSWq601HowLQcxAhqNPdaGONDtHw56Qhs0Ba8GA6329vLWgZ
+ODnXweiNSCDrv3xbIN6IjPyyO5AoUkxmJfD0mVtp3u5Ar7kfIw7ieGGxokaHewNL
+Xzqcp9rPiUR6dFw2uRvDdVRrXFUPlgVugaHKytm15JpHmQfyzQiMdYXnIz0oofJO
+WM/PY1iw+QJZ2M7PnfbTJeADXIc/EoOAJDRggih533SjhiCaT6FdPMMk6rCZ5cgl
+uQENBEtsQe8BCADlNPIJZVSL2i6H9X19YK4CpEqsjIUGISMB1cDT311WFSnhfuMs
+GL9xYRb8dlbyeJFFOyHNkIBmH5ekCvGRfS6qJYpcUQZZcWSjEMqBYQV5cw1efd0B
+ek64jfvrsLz8+YhKzn+NI8O3nyGvpEEWvOhN4hNjwkDhYbXLvAlsqagbnSMf+Htf
+3lgCGYa2gLiNIqNKWCsEVAan/Er6KS39WANGXi6ih0yjReBiU8WR6Qh2ylMi2xKw
+yHnTOsbWxP0hqALUa7N4AEGCXS/qn+vUz/hcIbt+eUNy45qoZcTT3dZsWGfJqknh
+RFMIuPiej7/WY4Ugzes5NG02ecDkDkpJvrSNABEBAAGJAR8EGAECAAkFAktsQe8C
+GwwACgkQnsvsRn8M6xABeggAlNkqbqa12L1bgaCgnGGdCiuXB3F6/VFmSQdUKpts
+EuqWH6rSp30r67PupzneX++ouh+9WD5O7gJ0kP3VQJpmXjT/QnN5ANjI4kAtRZUW
+qCXlXOxVAeXHL5oiKz0NM23Xc2rNAyfBQY8+SUYrKBalNBq5m68g8oogX8QD5u2F
+x+6C+QK9G2EBDD/NWgkKN3GOxpQ5DTdPHI5/fjwYFs1leIaQjjiyJwAifxB/1+w0
+VCHe2LDVpRXY5uBTefF2guhVYisKY6n5wNDaQpBmA8w17it5Yp8ge0HMN1A+aZ+6
+L6MsuHbG2OYDZgAk8eKhvyd0y/pAhZpNuQ82MMGBmcueSA==
+=74Cu
+-----END PGP PUBLIC KEY BLOCK-----
@@ -0,0 +1,28 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: SKS 1.1.0
+
+mQENBFCGsO8BCAC/Ch/vrPf4yEJr9pzQLJyUlptme89vE8vJmDtQejruhGfjnZkn84i7BCff
+VHsDSKWjhg5oZBAlIG6PPTEJh5bMKHZSoudWHUlvBALhvUoJI1F949aktSIPQ+jTmHl6Ko06
+H3dqVzyWSuDzNLD32XsSyeACUly9l3JQES/Eqhx6TtHWnFzZMtRBEZDKfxXmsoc4eFFXy1dd
+xKclCVQiFqDVuH4iG6PHYo5stwat+pZQvkMxYbv0/TgjBnxXuZFPjyrqXSxa2BSjlsKRVbzX
+tsPsTJ3hAs8yGIJTj5+CzH28JV89IdPruPxIIyG5xb90pwXsXyBbnnU2DqBInmhia1/7ABEB
+AAG0RVNlY3VyaXR5LTEwZ2VuIChHUEcgS2V5IGZvciAxMGdlbiBTZWN1cml0eSBUZWFtKSA8
+c2VjdXJpdHlAMTBnZW4uY29tPokBPgQTAQIAKAUCUIaw7wIbAwUJA7U4AAYLCQgHAwIGFQgC
+CQoLBBYCAwECHgECF4AACgkQE1O4YpAH3K9RcAgAoKcuQ3Ah0Uck8Vs7OldkXgOV3OBaYYd0
+QisU+VGkjKe2a/qsYC87nAh6YYBjU2PNpN4+mNALHyeeHcUC9VngSlqJMBgNJokoeoh0dumN
+X+Kkbo4Vz582Gvk6mK1pftDGN2rfpTcwlR1NTCsB7Vlgycb1FgrMbt/9NIT1U8Px/TkUuHZi
+LvWDxDBKRMQVtVmNyJvTLWSV4yiUl4qsZZTMvb/BzbCQYa6CoKvbZmlnlaFO1Cciqgq7xg14
+O5RJ2TE2fZAH/OBlhXV84nU4F6jddiLhPIbmQT2ovLPlNLA974xVFsf8IDV93XjfO/OAtHkX
++Ck+aA4YkI93TGSPnT11T7kBDQRQhrDvAQgAtlMs1cIcqvskrf3nKTWofChJc51ZecsEG2K8
+udALCwAHG7VPF+NDcKqPdLuZM9t72VmLMuqKDb7TmxTcRUSjvGC/FzlYD3dQ6IrgMtAzzZcq
+IPl2q/RWYNil9qMYQrmHvIvP+LNC70rpod1sAELadOdu1HuGbmV3YVxik3hArBmt/TPAjxHi
+96IvcAikH0zsQ7TnNjbdODvSp/k790m1s85+8fVUyitrrsFb7WC7mJJHku4y7mx77vTsPs7j
+68TX6EZEZ/vsLGH5dYWUIC81HteyjAq/qAenPGaXR+/InSZW+zdz/rG7tcchHxtrK+x1cmzz
+pYV4Vt5GcIsgfoXQAwARAQABiQElBBgBAgAPBQJQhrDvAhsMBQkDtTgAAAoJEBNTuGKQB9yv
+8ykH+gOVbWlgomR3UKGAChPw2Pym/h1LZrriKcfIX1kv6hmmfBoum7XnLwQDDppp/qxTy4NI
+HGBDbVWDHxDEb3ouk8IN2to9d8T/vEIwvabd9nF5CUjoejzjj2RHCZB85VwVwlNBapMos/AG
+kFX2537+CP9A4tncje7NkQafnWz9hm2aq5InxgNYpWyyj6iZw1QyLHCLYC9LHhbA0+mRB/qB
+z1GuLIb/mm+WSIc72IlAU3gKTuEWkR97KUIoJWMpOYbefolZruNN2iUD3ctkncYmzjZxRld7
+fL9T4DNpnQb8Ce9Ug7LO/QQq0Ic1YpqlIzpLtEv49DdX5QSBTcSmk5/nG+8=
+=AtX9
+-----END PGP PUBLIC KEY BLOCK-----
@@ -0,0 +1,67 @@
+<html>
+ <head>
+ <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/combo?2.7.0/build/reset-fonts/reset-fonts.css&2.7.0/build/base/base-min.css">
+ <title>MongoDB Documentation Project</title>
+ </head>
+
+ <body style="font-family: georgia, times, serif; font-size: 100%">
+ <h1 align="center">MongoDB Documentation Project</h1>
+ <h2>Current MongoDB Documentation Release:</h2>
+
+ <div class="admonition"
+ style="border: solid 1px #777777; background-color: #cfcfcf;
+ padding: 10px; margin: 10px 60px 20px; ">
+ <strong>Note:</strong> <em>The <a href="manual">MongoDB
+ Manual</a> is currently under development. See the <a
+ href="http://mongodb.org/">MongoDB Wiki</a> for the previous
+ documentation resource</em>.
+ </div>
+
+ <p><strong><a href="manual">Current Stable MongoDB Manual</a></strong></p>
+ <ul>
+ <li><a href="manual">HTML, multiple pages</a></li>
+ <li><a href="manual/single">HTML, single page</a></li>
+ <li><a href="manual/MongoDB-Manual.pdf">PDF</a></li>
+ <li><a href="manual/MongoDB-Manual.epub">ePub</a></li>
+ </ul>
+
+ <h2>Editions:</h2>
+ <ul>
+ <li><a href="master" ref="nofollow">master</a>
+ <ul>
+ <li><a href="master">HTML, multiple pages</a></li>
+ <li><a href="master/single/">HTML, single page</a></li>
+ <li><a href="manual/MongoDB-Manual-master.pdf">PDF</a></li>
+ <li><a href="manual/MongoDB-Manual-master.epub">ePub</a></li>
+ </ul></li>
+ <li>2.2</li>
+ <li>2.0</li>
+ <li>1.8</li>
+ </ul>
+
+ <h2>Translations:</h2>
+ <ul>
+ <li><a href="http://jp.docs.mongodb.org/">Japanese</a></li>
+ <li><a href="http://cn.docs.mongodb.org/">Chinese</a></li>
+ </ul>
+
+ <h2>Other MongoDB Documentation Resources:</h2>
+ <ul>
+ <li><a href="http://mongodb.org/">MongoDB Wiki</a></li>
+ <li><a href="http://api.mongodb.org/">Driver Documentation</a></li>
+ <li><a href="http://cookbook.mongodb.org/">MongoDB Cookbook</a></li>
+ </ul>
+
+ <h2>The MongoDB Documentation Project:</h2>
+ <ul>
+ <li><a href="http://jira.mongodb.org/browse/DOCS">Jira</a>:
+ Issue tracking for the documentation project. Open a new case
+ if you find a problem with the documentation.</li>
+ <li><a href="http://github.com/mongodb/docs">Core Documentation
+ Git Repository</a> (GitHub:) Source for the documentation
+ project. Fork this repository and issue pull requests to
+ contribute to the documentation.</li>
+ <li><a href="http://www.10gen.com/contributor">Contributor Agreement</a>.</li>
+ </ul>
+ </body>
+</html>
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+<ShortName>MongoDB Help</ShortName>
+<LongName>Google Custom Search of MongoDB documentation and wiki</LongName>
+<Description>Google Custom Search of MongoDB documentation (docs.mongodb.org) and wiki (www.mongodb.org/display/DOCS)</Description>
+<Tags>mongodb mongo mongodocs</Tags>
+<Query role="example" searchTerms="mongodb"/>
+<Image height="16" width="16" type="image/vnd.microsoft.icon">http://media.mongodb.org/favicon.ico</Image>
+<Developer>10gen, inc.</Developer>
+<Contact>sitesearch@10gen.com</Contact>
+<Url type="text/html" rel="results" template="http://www.google.com/cse?cx=017213726194841070573:WMX6838984&amp;ie=UTF-8&amp;q={searchTerms}" />
+<Url type="application/opensearchdescription+xml" rel="self" template="http://docs.mongodb.org/osd.xml"/>
+<Attribution>Google Custom Search by 10Gen.com</Attribution>
+</OpenSearchDescription>
@@ -0,0 +1,24 @@
+{#
+ epub/epub-cover.html
+ ~~~~~~~~~~~~~~~~~~~~
+
+ Sample template for the html cover page.
+
+ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+#}
+{% extends "layout.html" %}
+{%- block rootrellink %}{% endblock %}
+{%- block relbaritems %}{% endblock %}
+{%- block sidebarlogo %}{% endblock %}
+{%- block linktags %}{% endblock %}
+{%- block relbar1 %}{% endblock %}
+{%- block sidebar1 %}{% endblock %}
+{%- block sidebar2 %}{% endblock %}
+{%- block footer %}{% endblock %}
+
+{% block content %}
+ <div class="epub-cover">
+ <img src="{{ image }}" alt="Cover image" />
+ </div>
+{% endblock %}
@@ -0,0 +1,19 @@
+{#
+ epub/layout.html
+ ~~~~~~~~~~~~~~~~
+
+ Sphinx layout template for the epub theme.
+
+ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+#}
+{% extends "basic/layout.html" %}
+
+{# add only basic navigation links #}
+{% block header %}{% endblock %}
+{% block sidebar1 %}{% endblock %}
+{% block sidebar2 %}{% endblock %}
+{% block relbar1 %}{% endblock %}
+{% block relbar2 %}{% endblock %}
+{% block linktags %}{% endblock %}
+{% block footer %}{% endblock %}
Oops, something went wrong.

0 comments on commit 3c00e31

Please sign in to comment.