From 23e201df26d027c9923daa949b771f6598bc0b08 Mon Sep 17 00:00:00 2001 From: Emet Ozar Date: Wed, 29 Jul 2026 07:26:35 -0700 Subject: [PATCH] DOCSP-49937: Remove legacy build toolchain install instructions The legacy Giza/Sphinx toolchain docs have been archived, so remove the build tool install page, its steps file, the toctree entry, and the Install Build Tools step in the repo setup tutorial. --- source/includes/steps-install.yaml | 134 ----------------------------- source/includes/steps-repo.yaml | 9 -- source/tutorials.txt | 1 - source/tutorials/install.txt | 47 ---------- 4 files changed, 191 deletions(-) delete mode 100644 source/includes/steps-install.yaml delete mode 100644 source/tutorials/install.txt diff --git a/source/includes/steps-install.yaml b/source/includes/steps-install.yaml deleted file mode 100644 index 56a11ef7..00000000 --- a/source/includes/steps-install.yaml +++ /dev/null @@ -1,134 +0,0 @@ -title: "Install Xcode from the App Store." -ref: install-xcode -content: | - - Install `XCode `__. This installation - may take some time. - ---- - -title: "Install or link macOS SDK headers." -ref: install-headers -content: | - - The following step depends on which version of macOS you are running: - - .. tabs:: - - .. tab:: Mojave - :tabid: mojave - - If you are running macOS Mojave (10.14) or later, install the - macOS SDK headers by running the following command: - - .. code-block:: sh - - open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg - - .. tab:: Catalina or later - :tabid: catalina - - Run the following command to manually link the XCode libraries - to your local path: - - .. code-block:: sh - - ln -s '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/libxml2/libxml/' /usr/local/include - ---- - -title: Download and install Homebrew -ref: install-homebrew -content: | - - If `Homebrew `__ is not installed, install it: - - .. code-block:: sh - - /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - - When this completes, run the following commands: - - .. code-block:: sh - - brew update - brew doctor - ---- -title: Install Python 2 and Python 3 -ref: install-python -content: | - - The build tools require Python 3 and 2 *from Homebrew*. The version of Python - which comes with macOS is unsupported and will **not** work. - - Install Python 2 by running the following commands: - - .. code-block:: sh - - curl -LO https://raw.githubusercontent.com/Homebrew/homebrew-core/86a44a0a552c673a05f11018459c9f5faae3becc/Formula/python@2.rb - - brew unlink openssl && brew install python@2.rb - - Install Python 3 by running the following command: - - .. code-block:: sh - - brew install python@3.8 - ---- - -title: Install Giza -ref: install-giza -content: | - - Install Giza, Sphinx, and their dependencies with Python 2: - - .. code-block:: sh - - python -m pip install -r https://raw.githubusercontent.com/mongodb/docs-tools/master/giza/requirements.txt - - You might receive the an error containing the following text when you - try to install Giza, Sphinx, and their dependencies: - - .. code-block:: sh - - No module named pip - - If you receive this error, run the following commands, then try to - install Giza, Sphinx, and their dependencies again: - - .. code-block:: sh - - curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py - - python get-pip.py - ---- - -title: Install Mut -ref: install-mut -content: | - - Install Mut and its dependencies with Python 3: - - .. code-block:: sh - - brew install pkg-config - python3 -m pip install mut - ---- - -title: Install Inkscape -ref: install-inkscape -content: | - - First install XQuartz through Homebrew: - - .. code-block:: sh - - brew install --cask xquartz - - Once XQuartz is installed, `download and install Inkscape - `__. -... diff --git a/source/includes/steps-repo.yaml b/source/includes/steps-repo.yaml index 946ca3ce..4b07e64c 100644 --- a/source/includes/steps-repo.yaml +++ b/source/includes/steps-repo.yaml @@ -196,15 +196,6 @@ content: | branched: false ---- -title: Install Build Tools -ref: install-build -content: | - - You will need to :doc:`install the build tools ` in order to build your repository. - - Once you have installed the build tools, you can attempt to build your repository. - --- title: Running a Build Locally ref: run-build diff --git a/source/tutorials.txt b/source/tutorials.txt index 8be21f2c..9598ff70 100644 --- a/source/tutorials.txt +++ b/source/tutorials.txt @@ -12,6 +12,5 @@ Tutorials /tutorials/version-bumping /tutorials/generating-a-browser-list /error-kb - /tutorials/install /tutorials/repo /tutorials/guide diff --git a/source/tutorials/install.txt b/source/tutorials/install.txt deleted file mode 100644 index 39ba3ec8..00000000 --- a/source/tutorials/install.txt +++ /dev/null @@ -1,47 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -============================================ -Installing MongoDB Documentation Build Tools -============================================ - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -In this guide you will learn how to install the MongoDB Documentation -Build Tools on macOS. - -*Time required: 45 minutes* - -Prerequisites -------------- - -- macOS 10.14 or later. - -Procedure ---------- - -.. include:: /includes/steps/install.rst - -Summary -------- - -If you have successfully completed this guide, you have -installed the MongoDB Build Tools. - -What's Next ------------ - -Congratulations! Now that you've installed the Build Tools, you are -ready to start building your site. - -See Also --------- - -- For examples, see the `Guides site - `__. -- :doc:`Tabbed Content Tutorial ` -- :doc:`Create a Docstools-Enabled Repo `