add alias for diffpy.cmi and manually change non-rst file references

cadenmyers13 · cadenmyers13 · commit 10dc537a2b37 · 2025-09-17T13:06:46.000-04:00
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Sphinx sources for the [diffpy.org][site] web page.
 - [Where to Make Changes](#where-to-make-changes)
   - [Adding Citations](#adding-citations)
     - [Adding Publications that Describe a DiffPy Project (the "Reference" Section)](#reference-section-1)
-    - [Adding Other Publications (the "Publication Using DiffPy.CMI" Section)](#reference-section-2)
+    - [Adding Other Publications (the "Publication Using diffpy.cmi" Section)](#reference-section-2)
 - [New Version of Existing Project](#new-version)
 - [New Project](#publishing-new-project)
 - [Publishing Changes](#publishing-changes)
@@ -107,8 +107,8 @@ you add the reference to the proper section and do so in descending reverse chro
 (i.e., the newest citations should appear at the top of their respective sections).
 
 <a name="reference-section-note">*Note:*</a> In this example, the citation is for a publication 
-which describes a product of the DiffPy.CMI project (namely, PDFgetN3). For publications which 
-describe a component of DiffPy.CMI, we provide a link to download the publication directly from
+which describes a product of the diffpy.cmi project (namely, PDFgetN3). For publications which 
+describe a component of diffpy.cmi, we provide a link to download the publication directly from
 the [diffpy.org][site] website. Here, the link is provided via the `|downloadJuhasJac18|` tag
 which is the identifier for another snippet within [abbreviations.txt](https://github.com/diffpy/diffpy.github.io/blob/source/abbreviations.txt#L294) following the definition
 of `|citeJuhasJac18|`, seen here as:
@@ -130,10 +130,10 @@ placed within `pdfgetx`'s documentation directory and referenced accordingly wit
 
 
 <a name="reference-section-2"></a>
-### Adding Other Publications (the "Publication Using DiffPy.CMI" Section)
+### Adding Other Publications (the "Publication Using diffpy.cmi" Section)
 
-Adding references to publications that do not describe the release/use of a product within the DiffPy.CMI 
-project (e.g., papers which use some component of DiffPy.CMI), we simply provide the usual citation text (with
+Adding references to publications that do not describe the release/use of a product within the diffpy.cmi 
+project (e.g., papers which use some component of diffpy.cmi), we simply provide the usual citation text (with
 appropriate DOI link). To add a citation of this type, refer to the information in [Reference Section](#reference-section-1), but
 disregard everything starting at, and following, the [Note](#reference-section-note).
 
diff --git a/_includes/substitutions.rst b/_includes/substitutions.rst
@@ -0,0 +1,2 @@
+.. define global names and alias here
+.. |diffpycmi| replace:: diffpy.cmi
diff --git a/_templates/menu01.html b/_templates/menu01.html
@@ -7,7 +7,7 @@
   <ul class="dropdown-menu menu01"
       role="menu"
       aria-labelledby="dLabelMenu01">
-      <li><a href="{{pathto('products/diffpycmi/index')}}">DiffPy.CMI</a></li>
+      <li><a href="{{pathto('products/diffpycmi/index')}}">diffpy.cmi</a></li>
       <li><a href="{{pathto('products/xPDFsuite')}}">xPDFsuite</a></li>
       <li><a href="{{pathto('products/pdfgetx')}}">PDFgetX3, PDFgetN3 and PDFgetS3</a></li>
       <li><a href="{{pathto('products/pdfgui')}}">PDFgui</a></li>
diff --git a/abbreviations.txt b/abbreviations.txt
@@ -66,7 +66,7 @@
 
 
 .. |DiffPyCMI| replace::
-   :doc:`DiffPy.CMI </products/diffpycmi/index>`
+   :doc:`diffpy.cmi </products/diffpycmi/index>`
 
 .. |citeShiPRL14| replace:: Chenyang Shi, Majid Beidaghi, Michael
    Naguib, Olha Mashtalir, Yury Gogotsi, and Simon J. L. Billinge,
diff --git a/conf.py b/conf.py
@@ -40,6 +40,11 @@
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
 
+# The reST default prolog, included at the beginning of every source file.
+rst_prolog = """
+.. include:: _includes/substitutions.rst
+"""
+
 # The master toctree document.
 master_doc = 'index'
 
diff --git a/products/diffpycmi/LICENSE.txt b/products/diffpycmi/LICENSE.txt
@@ -14,15 +14,15 @@ Copyright (c) 2014-2019, Brookhaven Science Associates, Brookhaven National
     Laboratory
 
 
-The "DiffPy.CMI" is distributed subject to the following license conditions:
+The "diffpy.cmi" is distributed subject to the following license conditions:
 
 
 SOFTWARE LICENSE AGREEMENT
 
-    Software: DiffPy.CMI
+    Software: diffpy.cmi
 
 
-(1) The "Software", below, refers to the aforementioned DiffPy.CMI (in either
+(1) The "Software", below, refers to the aforementioned diffpy.cmi (in either
 source code, or binary form and accompanying documentation).
 
 Part of the software was derived from the DANSE, ObjCryst++ (with permission),
diff --git a/products/diffpycmi/cmi_exchange.rst b/products/diffpycmi/cmi_exchange.rst
@@ -2,9 +2,9 @@ CMI Exchange
 =============
 
 The `CMI Exchange`_ is a collection of community developed scripts,
-functions, and IPython plugins that make use of the DiffPy.CMI
-framework. If you are new to DiffPy.CMI it is a great place to get
-started.  If you've been working with DiffPy.CMI for a while and feel
+functions, and IPython plugins that make use of the |diffpycmi|
+framework. If you are new to |diffpycmi| it is a great place to get
+started.  If you've been working with |diffpycmi| for a while and feel
 that others would benefit from seeing your code please contribute!
 
 .. _cmi exchange: https://github.com/diffpy/cmi_exchange#cmi-exchange
diff --git a/products/diffpycmi/contents.rst b/products/diffpycmi/contents.rst
@@ -1,9 +1,9 @@
 .. _contents:
 
-DiffPy.CMI Contents
+|diffpycmi| Contents
 ===================
 
-The DiffPy.CMI release includes Python and C++ libraries developed by
+The |diffpycmi| release includes Python and C++ libraries developed by
 the DiffPy team as well as external libraries necessary for functionality.
 
 Libraries developed by the DiffPy team
diff --git a/products/diffpycmi/contributecode.rst b/products/diffpycmi/contributecode.rst
@@ -1,7 +1,7 @@
 How to Contribute Code
 ======================
 
-The DiffPy.CMI bundle consists of the following projects, all hosted on
+The |diffpycmi| bundle consists of the following projects, all hosted on
 github.  To contribute code simply fork the project you'd like to work
 on and issue a pull request.
 
diff --git a/products/diffpycmi/index.rst b/products/diffpycmi/index.rst
@@ -1,5 +1,5 @@
 ##########
-DiffPy.CMI
+|diffpycmi|
 ##########
 
 Diffpy.cmi is designed as an extensible complex modeling infrastructure. 
@@ -169,7 +169,7 @@ Tutorials
 =========
 
 * A step-by-step tutorial on using diffpy.cmi for PDF analysis is available at the documentation site for
-  ``DiffPy.CMI`` -- https://www.diffpy.org/diffpy.cmi/tutorials/index.html.
+  ``diffpy.cmi`` -- https://www.diffpy.org/diffpy.cmi/tutorials/index.html.
 
 * Worked examples and experimental data from the book *Atomic Pair Distribution Function Analysis: A Primer* are freely available at our
   `GitHub repository <https://github.com/Billingegroup/pdfttp_data>`_.
@@ -194,16 +194,16 @@ at the links below.
 * |doc-libdiffpy|_ -- C++ library for calculation of PDF and other real-space
   quantities
 
-See :ref:`DiffPy.CMI contents <contents>` for a complete list
-of open-source libraries that are included in DiffPy.CMI and
+See :ref:`diffpy.cmi contents <contents>` for a complete list
+of open-source libraries that are included in |diffpycmi| and
 their respective project pages.
 
 
 Reference
 =========
 
 If you use this software in a research work which leads to publication,
-we ask you to acknowledge the use of DiffPy.CMI by citing the following
+we ask you to acknowledge the use of |diffpycmi| by citing the following
 paper:
 
 * |citeJuhasAca15|
diff --git a/products/diffpycmi/install.rst b/products/diffpycmi/install.rst
@@ -1,16 +1,16 @@
 .. highlight:: bash
 
-DiffPy.CMI installation from sources
+|diffpycmi| installation from sources
 ====================================
 
-Downloaded the most recent `DiffPy.CMI tarball
+Downloaded the most recent `diffpy.cmi tarball
 <https://github.com/diffpy/diffpy-release/releases/latest>`__
 and follow the steps below.
 
 1 Install system software
 ------------------------------------------------------------------------
 
-DiffPy.CMI requires the :ref:`system software dependencies <dependencies>`
+|diffpycmi| requires the :ref:`system software dependencies <dependencies>`
 which can be installed from command line using a suitable package manager.
 Here are installation commands for several supported systems.
 
@@ -43,7 +43,7 @@ Mac OS X
 For Mac OS X the system dependencies can be installed using the
 `MacPorts <https://www.macports.org>`_ software manager.  A similar
 package system `Homebrew <https://brew.sh>`_ works as well, but has
-been considerably less tested with DiffPy.CMI.
+been considerably less tested with |diffpycmi|.
 
 For best results with MacPorts follow these tips:
 
@@ -79,10 +79,10 @@ of ``.profile`` or ``.zshenv`` file in your HOME directory ::
     export PATH="/opt/local/bin:$PATH"
 
 
-2 Install DiffPy.CMI
+2 Install |diffpycmi|
 ------------------------------------------------------------------------
 
-Unzip the DiffPy.CMI tarball into a directory of your choice.
+Unzip the |diffpycmi| tarball into a directory of your choice.
 Execute the included :file:`install` script and follow the prompts. ::
 
    # replace VERSION to match the actual filename
@@ -143,7 +143,7 @@ the base diffpy_cmi directory and create the symbolic link with ::
 
 .. note::
 
-   The installation of DiffPy.CMI is entirely contained under the
+   The installation of |diffpycmi| is entirely contained under the
    expanded diffpy_cmi directory.  The software can be completely
    uninstalled by deleting that directory and removing the symbolic
    link.
diff --git a/products/diffpycmi/license.rst b/products/diffpycmi/license.rst
@@ -1,6 +1,6 @@
-.. this page only contains the LICENSE text for DiffPy.CMI
+.. this page only contains the LICENSE text for |diffpycmi|
 
-.. title:: DiffPy.CMI License
+.. title:: |diffpycmi| License
 
 .. literalinclude:: LICENSE.txt
    :language: text
diff --git a/products/diffpycmi/updatesources.rst b/products/diffpycmi/updatesources.rst
@@ -48,4 +48,4 @@ cases, you could use option -n to display the build steps.
    other than system Python (e.g. the Enthought Python Distribution) it
    may be incompatible with the system boost library and the build may
    fail. To resolve the problem, you should rebuild the boost library
-   against Enthought Python and then rebuild all DiffPy.CMI modules.
+   against Enthought Python and then rebuild all diffpy.cmi modules.
diff --git a/products/mPDF.rst b/products/mPDF.rst
@@ -44,7 +44,7 @@ Installation
 The recommended way to install this package is through conda. For help installing conda,
 please visit |anaconda-download|.
 Once conda is installed, you can follow the simple steps below to install diffpy.mpdf.
-You will also install the full DiffPy.CMI suite along the way.
+You will also install the full |diffpycmi| suite along the way.
 
 *Step 1: Add the appropriate conda channels to your conda configuration.* ::
 
@@ -66,7 +66,7 @@ after the --name flag in the first command.
 
     conda install diffpy.mpdf
 
-Note that this will also install the full DiffPy.CMI suite if it has not already been
+Note that this will also install the full |diffpycmi| suite if it has not already been
 installed in this environment.
 
 *Alternative option: Install from the python package index.*
diff --git a/products/xPDFsuite.rst b/products/xPDFsuite.rst
@@ -51,7 +51,7 @@ xPDFsuite is available for purchase for either academic or commercial applicatio
 .. _CTV_link: ctv-xpdfsuite_
 
 **Thank you for purchasing xPDFsuite. Funds we raise from sales help us to develop user interfaces and useful features on top of our
-free for academics and open source Diffpy products, such as DiffPy.CMI, PDFgetX3 and PDFgui.**
+free for academics and open source Diffpy products, such as |diffpycmi|, PDFgetX3 and PDFgui.**
 
 **We hope you enjoy xPDFsuite and that it supercharges your PDF analyses.**  Please contact us with feedback and questions by
 emailing `Prof. Simon Billinge  <sb2896@columbia.edu>`_
diff --git a/products/xinterpdf.rst b/products/xinterpdf.rst
@@ -4,7 +4,7 @@ xINTERPDF
 
 xINTERPDF is a Python GUI program for analyzing X-ray pair distribution
 function (PDF) data of organic compounds collected at synchrotron and/or
-laboratory X-ray sources. It uses DiffPy.CMI as a backend for simulation
+laboratory X-ray sources. It uses |diffpycmi| as a backend for simulation
 of PDFs.
 
 Currently it supports:
@@ -39,7 +39,7 @@ The xINTERPDF package requires Python 2.7 and the following dependency packages:
 * ``SciPy`` - Scientific libraries for Python
 * ``matplotlib`` - Python plotting library
 * ``Scikit-Learn`` - Python machine learning library; its PCA module is called.
-* ``DiffPy.CMI`` - Versatile Python packages for simulation of atomic pair distribution functions
+* ``diffpy.cmi`` - Versatile Python packages for simulation of atomic pair distribution functions
 * ``Tkinter`` - Python default library for creation of graphical user interface
 
 See the :doc:`xINTERPDF license <xinterpdflicense>` for terms and conditions of use.
diff --git a/publications.rst b/publications.rst
@@ -24,7 +24,7 @@ Please cite us if our software has been used in your research.
 
 
 
-Publications using DiffPy.CMI
+Publications using |diffpycmi|
 =============================
 
 The following papers made use of DiffPy developed software for analysis
diff --git a/static_root/doc/pdfgetx/2.0.0/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.0.0/_sources/tutorial.rst.txt
@@ -645,9 +645,9 @@ the zero offset may change for different samples.
 
 This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-`DiffPy.CMI <https://www.diffpy.org/products/diffpycmi/index.html>`__,
+`diffpy.cmi <https://www.diffpy.org/products/diffpycmi/index.html>`__,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use `Anaconda Python`_ and set up a dedicated
 Anaconda environment *nbcmi* for this tutorial.
 This can be accomplished using the following steps::
diff --git a/static_root/doc/pdfgetx/2.0.0/tutorial.html b/static_root/doc/pdfgetx/2.0.0/tutorial.html
@@ -644,9 +644,9 @@ <h2>Fit twothetazero<a class="headerlink" href="#fit-twothetazero" title="Permal
 the zero offset may change for different samples.</p>
 <p>This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">DiffPy.CMI</a>,
+<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">diffpy.cmi</a>,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use <a class="reference external" href="https://www.anaconda.com/download">Anaconda Python</a> and set up a dedicated
 Anaconda environment <em>nbcmi</em> for this tutorial.
 This can be accomplished using the following steps:</p>
diff --git a/static_root/doc/pdfgetx/2.1.0/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.1.0/_sources/tutorial.rst.txt
@@ -644,9 +644,9 @@ the zero offset may change for different samples.
 
 This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-`DiffPy.CMI <https://www.diffpy.org/products/diffpycmi/index.html>`__,
+`diffpy.cmi <https://www.diffpy.org/products/diffpycmi/index.html>`__,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use `Anaconda Python`_ and set up a dedicated
 Anaconda environment *nbcmi* for this tutorial.
 This can be accomplished using the following steps::
diff --git a/static_root/doc/pdfgetx/2.1.0/tutorial.html b/static_root/doc/pdfgetx/2.1.0/tutorial.html
@@ -646,9 +646,9 @@ <h2>Fit twothetazero<a class="headerlink" href="#fit-twothetazero" title="Permal
 the zero offset may change for different samples.</p>
 <p>This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">DiffPy.CMI</a>,
+<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">diffpy.cmi</a>,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use <a class="reference external" href="https://www.anaconda.com/download">Anaconda Python</a> and set up a dedicated
 Anaconda environment <em>nbcmi</em> for this tutorial.
 This can be accomplished using the following steps:</p>
diff --git a/static_root/doc/pdfgetx/2.1.1/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.1.1/_sources/tutorial.rst.txt
@@ -644,9 +644,9 @@ the zero offset may change for different samples.
 
 This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-`DiffPy.CMI <https://www.diffpy.org/products/diffpycmi/index.html>`__,
+`diffpy.cmi <https://www.diffpy.org/products/diffpycmi/index.html>`__,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use `Anaconda Python`_ and set up a dedicated
 Anaconda environment *nbcmi* for this tutorial.
 This can be accomplished using the following steps::
diff --git a/static_root/doc/pdfgetx/2.1.1/tutorial.html b/static_root/doc/pdfgetx/2.1.1/tutorial.html
@@ -646,9 +646,9 @@ <h2>Fit twothetazero<a class="headerlink" href="#fit-twothetazero" title="Permal
 the zero offset may change for different samples.</p>
 <p>This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">DiffPy.CMI</a>,
+<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">diffpy.cmi</a>,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use <a class="reference external" href="https://www.anaconda.com/download">Anaconda Python</a> and set up a dedicated
 Anaconda environment <em>nbcmi</em> for this tutorial.
 This can be accomplished using the following steps:</p>
diff --git a/static_root/doc/pdfgetx/2.1.2/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.1.2/_sources/tutorial.rst.txt
@@ -644,9 +644,9 @@ the zero offset may change for different samples.
 
 This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-`DiffPy.CMI <https://www.diffpy.org/products/diffpycmi/index.html>`__,
+`diffpy.cmi <https://www.diffpy.org/products/diffpycmi/index.html>`__,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use `Anaconda Python`_ and set up a dedicated
 Anaconda environment *nbcmi* for this tutorial.
 This can be accomplished using the following steps::
diff --git a/static_root/doc/pdfgetx/2.1.2/tutorial.html b/static_root/doc/pdfgetx/2.1.2/tutorial.html
@@ -646,9 +646,9 @@ <h2>Fit twothetazero<a class="headerlink" href="#fit-twothetazero" title="Permal
 the zero offset may change for different samples.</p>
 <p>This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">DiffPy.CMI</a>,
+<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">diffpy.cmi</a>,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use <a class="reference external" href="https://www.anaconda.com/download">Anaconda Python</a> and set up a dedicated
 Anaconda environment <em>nbcmi</em> for this tutorial.
 This can be accomplished using the following steps:</p>
diff --git a/static_root/doc/pdfgetx/2.2.0/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.2.0/_sources/tutorial.rst.txt
@@ -644,9 +644,9 @@ the zero offset may change for different samples.
 
 This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-`DiffPy.CMI <https://www.diffpy.org/products/diffpycmi/index.html>`__,
+`diffpy.cmi <https://www.diffpy.org/products/diffpycmi/index.html>`__,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use `Anaconda Python`_ and set up a dedicated
 Anaconda environment *nbcmi* for this tutorial.
 This can be accomplished using the following steps::
diff --git a/static_root/doc/pdfgetx/2.2.0/tutorial.html b/static_root/doc/pdfgetx/2.2.0/tutorial.html
@@ -646,9 +646,9 @@ <h2>Fit twothetazero<a class="headerlink" href="#fit-twothetazero" title="Permal
 the zero offset may change for different samples.</p>
 <p>This tutorial requires either Linux or Mac OS X platforms,
 because the PDF fitting is conducted with
-<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">DiffPy.CMI</a>,
+<a class="reference external" href="https://www.diffpy.org/products/diffpycmi/index.html">diffpy.cmi</a>,
 which is not yet available for Windows.
-If DiffPy.CMI is not yet installed,
+If diffpy.cmi is not yet installed,
 we recommend to use <a class="reference external" href="https://www.anaconda.com/download">Anaconda Python</a> and set up a dedicated
 Anaconda environment <em>nbcmi</em> for this tutorial.
 This can be accomplished using the following steps:</p>
diff --git a/static_root/doc/pdfgetx/2.2.1/_sources/tutorial.rst.txt b/static_root/doc/pdfgetx/2.2.1/_sources/tutorial.rst.txt
diff --git a/static_root/doc/pdfgetx/2.2.1/tutorial.html b/static_root/doc/pdfgetx/2.2.1/tutorial.html

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+.. define global names and alias here`
	`2`	`+.. \|diffpycmi\| replace:: diffpy.cmi`