Skip to content

Commit

Permalink
primer: updated for new editions
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Kleinman committed Oct 6, 2014
1 parent d9cab1f commit 65fedd1
Show file tree
Hide file tree
Showing 12 changed files with 176 additions and 40 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ source/includes/steps/
source/includes/generated/includes-overview.rst
source/includes/generated/
source/includes/option/
primer/config/sphinx.yaml
primer/conf.py
primer/source/includes/toc/
primer/source/includes/table/
Expand Down
3 changes: 2 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
try:
from giza.config.runtime import RuntimeStateConfig
from giza.config.helper import fetch_config, get_versions, get_manual_path
from giza.strings import dot_concat
from giza.tools.strings import dot_concat

conf = fetch_config(RuntimeStateConfig())
intersphinx_libs = conf.system.files.data.intersphinx
sconf = conf.system.files.data.sphinx_local

print os.path.join(conf.paths.projectroot, conf.paths.buildsystem, 'sphinxext')
sys.path.append(os.path.join(conf.paths.projectroot, conf.paths.buildsystem, 'sphinxext'))
except ImportError:
try:
Expand Down
18 changes: 7 additions & 11 deletions primer/config/build_conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,23 @@ project:
title: 'MongoDB Primer'
branched: false
editions:
- name: primer
- name: shell
branched: false
- name: python
branched: false
version:
release: '2.6.1'
branch: '2.6'
system:
make:
generated:
- 'sphinx'
- 'meta'
- 'integration'
- 'push'
static:
- 'makefile.compatibility'
- 'makefile.clean'
- 'makefile.dtf'
files:
- 'integration.yaml'
- 'push.yaml'
- 'sphinx_local.yaml'
- 'intersphinx.yaml'
assets:
- branch: master
path: build/docs-tools
repository: https://github.com/mongodb/docs-tools.git
paths:
output: 'build'
source: 'source'
Expand Down
31 changes: 22 additions & 9 deletions primer/config/integration.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
targets:
# - latex
# - json
- html
- dirhtml
- singlehtml
- epub
doc-root: []
branch-root: []
fr:
inherit: base
es:
inherit: base
ja:
inherit: base
zh:
inherit: base
it:
inherit: base
base:
targets:
# - 'latex'
# - 'json'
# - 'man'
# - 'epub'
# - 'singlehtml'
- 'html'
- 'dirhtml'
links: []
doc-root: []
branch-root: []
133 changes: 133 additions & 0 deletions primer/config/sphinx.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# The items in the ``sphinx`` list are the name of Sphinx builders
# supported by ``sphinx-build``.

editions:
- 'shell'
- 'python'
- 'java'
### --- ####
java-web-base:
edition: java
inherit: java-base
tags:
- java
- hosted
- web
- website
java-print-base:
edition: java
inherit: java-base
tags:
- hosted
- java
- print

python-web-base:
edition: python
inherit: python-base
tags:
- python
- web
- website
python-print-base:
edition: python
inherit: python-base
tags:
- python
- print
shell-web-base:
edition: shell
inherit: shell-base
tags:
- shell
- web
- website
shell-print-base:
edition: shell
inherit: shell-base
tags:
- shell
- print
### --- ####
dirhtml-python:
builder: dirhtml
inherit: python-web-base
html-python:
builder: html
inherit: python-web-base
gettext-python:
builder: gettext
inherit: python-web-base
singlehtml-python:
builder: singlehtml
inherit: python-web-base
epub-python:
builder: epub
inherit: python-print-base
latex-python:
builder: latex
inherit: python-print-base
json-python:
builder: json
inherit: python-web-base

dirhtml-java:
builder: dirhtml
inherit: java-web-base
html-java:
builder: html
inherit: java-web-base
gettext-java:
builder: gettext
inherit: java-web-base
singlehtml-java:
builder: singlehtml
inherit: java-web-base
epub-java:
builder: epub
inherit: java-print-base
json-java:
builder: json
inherit: java-web-base
latex-java:
builder: latex
inherit: java-print-base

dirhtml-shell:
builder: dirhtml
inherit: shell-web-base
html-shell:
builder: html
inherit: shell-web-base
gettext-shell:
builder: gettext
inherit: shell-web-base
singlehtml-shell:
builder: singlehtml
inherit: shell-web-base
epub-shell:
builder: epub
inherit: shell-print-base
json-shell:
builder: json
inherit: shell-web-base
latex-shell:
builder: latex
inherit: shell-print-base
### --- ####
root-base:
languages: ['es', 'fr', 'ja', 'it', 'zh']
tags: ['primer', 'getting-started']
java-base:
inherit: root-base
edition: java
excluded: []
python-base:
inherit: root-base
edition: python
excluded: []
shell-base:
inherit: root-base
edition: shell
excluded: []
...
10 changes: 2 additions & 8 deletions primer/config/sphinx_local.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,13 @@ paths:
theme:
name: 'primer'
project: 'primer'
sitename: "MongoDB Primer"
google_analytics: 'UA-7301842-8'
book_path_base: 'MongoDB-primer'
repo: 'docs'
jira: 'DOCS'
nav_excluded:
- '/indexes'
- '/insert'
- '/installation'
- '/modify'
- '/query'
sitename: 'Getting Started with MongoDB'
nav_excluded: []
sidebars:
'**':
- 'pagenav.html'
- 'formats.html'
...
8 changes: 2 additions & 6 deletions primer/makefile
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
MAKEFLAGS += -j -r --no-print-directory

output = build

noop:
bootstrap fabfile build/docs-tools:
@python bootstrap.py
@echo "[bootstrap]: configured build environment."

-include $(output)/makefile.meta
%:
giza make $@
8 changes: 8 additions & 0 deletions primer/source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ MongoDB. Upon initial release, all of the examples in the Primer use
complete administrative interface for MongoDB and fully featured
client.

.. only:: shell

only in shell builder

.. only:: python

only in python builder

.. class:: hidden

.. toctree::
Expand Down
1 change: 0 additions & 1 deletion primer/source/tutorial/install-mongodb-on-debian.txt

This file was deleted.

1 change: 0 additions & 1 deletion primer/source/tutorial/install-mongodb-on-linux.txt

This file was deleted.

1 change: 0 additions & 1 deletion primer/source/tutorial/install-mongodb-on-os-x.txt

This file was deleted.

1 change: 0 additions & 1 deletion primer/source/tutorial/install-mongodb-on-ubuntu.txt

This file was deleted.

0 comments on commit 65fedd1

Please sign in to comment.