Local documentation builder modeled after the driver one (#260)

* Local documentation builder modeled after the driver one

* add Makefile

Co-authored-by: Oleg Pudeyev <[email protected]>

Author: p-mongo

.gitignore

@@ -14,7 +14,6 @@ tmp/*
 *.bundle
 *.so
 core
-Makefile
 .idea/
 *.gem
 perf/profile.rb
@@ -32,3 +31,4 @@ lib/*.jar
 .byebug_history
 .env
 .env.private*
+docs/_build

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,17 @@
+Ruby BSON Documentation
+=======================
+
+This subdirectory contains the high-level driver documentation, including
+tutorials and the reference.
+
+Building the documentation for publishing is done via the
+[docs-ruby repo](https://github.com/mongodb/docs-ruby).
+
+To build the documentation locally for review, install `sphinx` and
+`sphinx-book-theme`, then execute `make html` in this directory:
+
+    pip install sphinx sphinx-book-theme
+    make html
+
+Note that the documentation generated in this manner wouldn't have the
+BSON documentation included, nor are intersphinx links currently handled.

docs/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Ruby BSON'
+copyright = '2021, MongoDB'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+source_suffix = {
+    '.txt': 'restructuredtext',
+}
+
+html_theme = 'sphinx_book_theme'

docs/index.txt

@@ -0,0 +1 @@
+tutorials/bson-v4.txt