This repository contains documentation regarding components of the MongoDB ecosystem that lay outside of the core server functionality. This documentation builds on the work of the MongoDB Manual <http://docs.mongodb.org/manual/>. You can download and build this documentation locally if you already have Sphinx installed, with the following command:
pip install giza git clone git://github.com/mongodb/docs-ecosystem cd docs-ecosystem/ make html
To build on Windows (using Cygwin):
- Ensure you have python installed
- install Sphinx using
easy_install -U Sphinx - install pyyamml using
pip install pyyaml - Build the docs using
sphinx-build -b html -d build/doctrees-html -c ./ source build/html
You may also wish to install Pygments to provide syntax highlighting for code examples.
The MongoDB Documentation Project is governed by the terms of the MongoDB Contributor Agreement.
To contribute to the documentation,
- If you have not done so already, please sign the MongoDB Contributor Agreement.
- Fork this repository on GitHub and issue a pull request.
File issue reports or requests at the Documentation Jira Project.
All documentation is available under the terms of a Creative Commons License.
If you have any questions, please contact [email protected].
-- The MongoDB/10gen Docs Team