{"id":15154122,"url":"https://github.com/mongodb/docs-tools","last_synced_at":"2025-09-30T01:32:34.497Z","repository":{"id":8589592,"uuid":"10223615","full_name":"mongodb/docs-tools","owner":"mongodb","description":"Common tools and content for MongoDB documentation projects.","archived":true,"fork":false,"pushed_at":"2024-01-24T19:14:07.000Z","size":16208,"stargazers_count":42,"open_issues_count":10,"forks_count":113,"subscribers_count":37,"default_branch":"master","last_synced_at":"2024-09-23T01:06:55.195Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mongodb.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-05-22T15:47:12.000Z","updated_at":"2024-05-08T10:25:24.000Z","dependencies_parsed_at":"2023-09-29T00:56:44.977Z","dependency_job_id":"98a0b685-31f6-4853-bb37-479294e734ee","html_url":"https://github.com/mongodb/docs-tools","commit_stats":{"total_commits":3235,"total_committers":87,"mean_commits":37.18390804597701,"dds":0.5088098918083462,"last_synced_commit":"77065c6e41536c86f958c4e7471d7dd9c98d9925"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fdocs-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fdocs-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fdocs-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mongodb%2Fdocs-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mongodb","download_url":"https://codeload.github.com/mongodb/docs-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219874735,"owners_count":16554611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-26T17:02:35.781Z","updated_at":"2025-09-30T01:32:33.702Z","avatar_url":"https://github.com/mongodb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===========================================================================\n``docs-tools`` -- Buildsystem Components for MongoDB Documentation Projects\n===========================================================================\n\n``docs-tools`` holds all common build system components for MongoDB\ndocumenting projects (e.g. the MongoDB Manual, MongoDB Ecosystem\nDocumentation, etc.) These tools include: Sphinx extensions, the\nmeta-build system, themes, deployment and orchestration scripts, and\nscripts that generate common restructured text elements.\n\nThe goal of ``docs-tools`` is to totally remove all programs from the\ndocumentation source trees to facilitate maintenance of these\ncomponents in the context of a multi-branch and multi-repository\ndocumentation project.\n\nThis document explains the components and operations of the build\nsystem, and serves as a guide for anyone who wants to maintain a\nMongoDB Documentation-like project. \n\nInstallation\n------------\n\nTo install giza, refer to the `installation guide \n\u003chttps://docs.mongodb.com/meta/tutorials/install/\u003e`_ on the MongoDB meta site\nto help you get started.\n\nComponents\n----------\n\n``sphinxext`` (Sphinx)\n~~~~~~~~~~~~~~~~~~~~~~\n\nThis directory contains conventional `Sphinx \u003chttp://sphinx-doc.org\u003e`_\nextensions, required for producing and referencing MongoDB\ndocumentation projects. This includes the extensions for the MongoDB\nDomain to cross reference MongoDB objects (database commands, shell\nmethods, database output, etc.) as well as custom admonition and\ndirective types. \n\n``themes`` (Sphinx)\n~~~~~~~~~~~~~~~~~~~\n\nThese are standard Sphinx themes customized for MongoDB documentation\nprojects, centralized here for ease of use across projects.\n\n``dtf`` (testing)\n~~~~~~~~~~~~~~~~~\n\n`dtf \u003chttps://pypi.python.org/pypi/dtf/\u003e`_ is a consistency testing\nframework for documentation projects to provide ways of enforcing\nconventions in documentation. The content of these scripts just\ninclude the test logic, and not the testing running architecture, or\ndata used to define testable situations.\n\n``bin`` (utilities)\n~~~~~~~~~~~~~~~~~~~\n\nThe scripts in the ``bin`` directory include common components and\nlogic shared between bootstrapping operations, fabric scripts, and\nmeta-build scripts.\n\n``giza``\n~~~~~~~~\n\nMongoDB's legacy toolchain that extends Sphinx.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Fdocs-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmongodb%2Fdocs-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmongodb%2Fdocs-tools/lists"}