Skip to content
This repository has been archived by the owner on Mar 5, 2024. It is now read-only.
/ docs-tools Public archive

Common tools and content for MongoDB documentation projects.

Notifications You must be signed in to change notification settings

mongodb/docs-tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs-tools -- Buildsystem Components for MongoDB Documentation Projects

docs-tools holds all common build system components for MongoDB documenting projects (e.g. the MongoDB Manual, MongoDB Ecosystem Documentation, etc.) These tools include: Sphinx extensions, the meta-build system, themes, deployment and orchestration scripts, and scripts that generate common restructured text elements.

The goal of docs-tools is to totally remove all programs from the documentation source trees to facilitate maintenance of these components in the context of a multi-branch and multi-repository documentation project.

This document explains the components and operations of the build system, and serves as a guide for anyone who wants to maintain a MongoDB Documentation-like project.

Installation

To install giza, refer to the installation guide on the MongoDB meta site to help you get started.

Components

sphinxext (Sphinx)

This directory contains conventional Sphinx extensions, required for producing and referencing MongoDB documentation projects. This includes the extensions for the MongoDB Domain to cross reference MongoDB objects (database commands, shell methods, database output, etc.) as well as custom admonition and directive types.

themes (Sphinx)

These are standard Sphinx themes customized for MongoDB documentation projects, centralized here for ease of use across projects.

dtf (testing)

dtf is a consistency testing framework for documentation projects to provide ways of enforcing conventions in documentation. The content of these scripts just include the test logic, and not the testing running architecture, or data used to define testable situations.

bin (utilities)

The scripts in the bin directory include common components and logic shared between bootstrapping operations, fabric scripts, and meta-build scripts.

giza

MongoDB's legacy toolchain that extends Sphinx.

About

Common tools and content for MongoDB documentation projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published