Rename package to appease OISM (#21)

usnistgov · Dec 5, 2023 · 76d40f8 · 76d40f8
1 parent 3038c8c
commit 76d40f8
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 41 deletions.
diff --git a/.github/workflows/NISTtheDocs2Death.yml → .github/workflows/Docs4NIST.yml b/.github/workflows/NISTtheDocs2Death.yml → .github/workflows/Docs4NIST.yml
@@ -6,7 +6,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: usnistgov/NISTtheDocs2Death@main
+      - uses: usnistgov/Docs4NIST@main
         with:
           docs-folder: docs/
           formats: |-

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# NISTtheDocs2Death Action
+# Docs4NIST Action
 
 This is a GitHub action that uses sphinx to build documentation and then
 host on <https://pages.nist.gov> as an approximation of
@@ -7,7 +7,7 @@ host on <https://pages.nist.gov> as an approximation of
 ## Usage
 
 - [Configure your repo for publishing on `pages.nist.gov`](https://github.com/usnistgov/pages-root/wiki/Configuring-your-repo-for-publishing-on-pages.nist.gov)
-- Create a workflow, such as `.github/workflows/NISTtheDocs2Death.yml`:
+- Create a workflow, such as `.github/workflows/Docs4NIST.yml`:
 
     ```yaml
     name: "Build Documentation"
@@ -18,7 +18,7 @@ host on <https://pages.nist.gov> as an approximation of
       docs:
         runs-on: ubuntu-latest
         steps:
-          - uses: usnistgov/NISTtheDocs2Death@0.4
+          - uses: usnistgov/Docs4NIST@0.5
             with:
               docs-folder: docs/
               formats: |-
@@ -33,4 +33,4 @@ elements, so
 to declare formats, as illustrated above.
 
 The self-generated documentation for this action is available at
-<https://pages.nist.gov/NISTtheDocs2Death>.
+<https://pages.nist.gov/Docs4NIST>.
diff --git a/action.yml b/action.yml
@@ -1,6 +1,6 @@
 # This is a basic workflow that is manually triggered
 
-name: NISTtheDocs2Death
+name: Docs4NIST
 description: Deploys Sphinx-built documentation to https://pages.nist.gov
 author: Jonathan Guyer
 
@@ -115,7 +115,7 @@ runs:
       id: ntd2d
       # from https://github.com/orgs/community/discussions/41927#discussioncomment-4605881
       # @mbrancato
-      # because usnistgov/NISTtheDocs2Death/ntd2d@${{ github.action_ref }}
+      # because usnistgov/Docs4NIST/ntd2d@${{ github.action_ref }}
       # doesn't work
       uses: ./../../_actions/current/ntd2d
       with:

diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'NISTtheDocs2Death'
+project = 'Docs4NIST'
 copyright = u'works of NIST employees are not not subject to copyright protection in the United States'
 author = 'Jonathan E. Guyer'
 

diff --git a/docs/customization.rst b/docs/customization.rst
@@ -1,7 +1,7 @@
 Customization
 =============
 
-NISTtheDocs2Death uses two sets of templates that determine the appearance 
+Docs4NIST uses two sets of templates that determine the appearance
 of the hosted documentation.
 
 Assimilation templates
@@ -41,13 +41,13 @@ menu that allows selecting different versions of your documentation.
 This template file controls the appearance of the dropdown menu.
 
 .. |conf.py|  replace:: :file:`conf.py`
-.. _conf.py:  https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/conf.py
+.. _conf.py:  https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/conf.py
 .. |ntd2d|    replace:: :file:`ntd2d/`
-.. _ntd2d:    https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/
+.. _ntd2d:    https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/
 .. |layout.html|  replace:: :file:`ntd2d/layout.html`
-.. _layout.html:  https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/layout.html
+.. _layout.html:  https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/layout.html
 .. |static/ntd2d.css_t|  replace:: :file:`ntd2d/static/ntd2d.css_t`
-.. _static/ntd2d.css_t:  https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/static/ntd2d.css_t
+.. _static/ntd2d.css_t:  https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d/static/ntd2d.css_t
 
 Pages templates
 --------------------------
@@ -175,17 +175,17 @@ Available subsitution keywords are:
 
 
 .. |downloads.html|   replace:: :file:`downloads.html`
-.. _downloads.html:   https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/downloads.html
+.. _downloads.html:   https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/downloads.html
 .. |download_item.html| replace:: :file:`download_item.html`
-.. _download_item.html: https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/download_item.html
+.. _download_item.html: https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/download_item.html
 .. |index.html|       replace:: :file:`index.html`
-.. _index.html:       https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/index.html
+.. _index.html:       https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/index.html
 .. |menu.html|        replace:: :file:`menu.html`
-.. _menu.html:        https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/menu.html
+.. _menu.html:        https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/menu.html
 .. |ntd2d_active.css| replace:: :file:`ntd2d_active.css`
-.. _ntd2d_active.css: https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d_active.css
+.. _ntd2d_active.css: https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/ntd2d_active.css
 .. |variants.html|    replace:: :file:`variants.html`
-.. _variants.html:    https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/variants.html
+.. _variants.html:    https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/variants.html
 .. |variant_item.html| replace:: :file:`variant_item.html`
-.. _variant_item.html: https://github.com/usnistgov/NISTtheDocs2Death/blob/main/ntd2d/ntd2d_action/files/templates/variant_item.html
+.. _variant_item.html: https://github.com/usnistgov/Docs4NIST/blob/main/ntd2d/ntd2d_action/files/templates/variant_item.html
 
diff --git a/docs/nistthedocs2death.rst → docs/docs4nist.rst b/docs/nistthedocs2death.rst → docs/docs4nist.rst
@@ -1,7 +1,7 @@
-.. _NISTTHEDOCS2DEATH:
+.. _DOCS4NIST:
 
-``NISTtheDocs2Death`` Action
-============================
+``Docs4NIST`` Action
+====================
 
 This `GitHub action <https://docs.github.com/en/actions>`_ uses the `Sphinx
 <https://www.sphinx-doc.org/>`_ tool to build documentation in
@@ -13,7 +13,7 @@ Usage
 -----
 
 This action is invoked by adding a workflow file to your repository, such 
-as :file:`.github/workflows/NISTtheDocs2Death.yml`:
+as :file:`.github/workflows/Docs4NIST.yml`:
 
 .. code-block:: yaml
 
@@ -25,7 +25,7 @@ as :file:`.github/workflows/NISTtheDocs2Death.yml`:
      docs:
        runs-on: ubuntu-latest
        steps:
-         - uses: usnistgov/NISTtheDocs2Death@0.4
+         - uses: usnistgov/Docs4NIST@0.4
            with:
              docs-folder: docs/
              pages-branch: 'nist-pages'

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,7 @@
-.. _NISTTHEDOCS2DEATH_INTRO:
+.. _DOCS4NIST_INTRO:
 
-``NISTtheDocs2Death``
-=====================
+``Docs4NIST``
+=============
 
 This `GitHub action <https://docs.github.com/en/actions>`_ [#]_ uses the
 `Sphinx <https://www.sphinx-doc.org/>`_ tool to build documentation in
@@ -21,7 +21,7 @@ Usage
   and select "Allow all actions and reusable workflows" (you may need to
   submit a request to devops@nist.gov to enable this for you).
 - For each branch of your repository where you want to host documentation, 
-  add a workflow, such as :file:`.github/workflows/NISTtheDocs2Death.yml`:
+  add a workflow, such as :file:`.github/workflows/Docs4NIST.yml`:
 
 .. code-block:: yaml
 
@@ -33,14 +33,14 @@ Usage
      docs:
        runs-on: ubuntu-latest
        steps:
-         - uses: usnistgov/NISTtheDocs2Death@0.4
+         - uses: usnistgov/Docs4NIST@0.5
            with:
              docs-folder: docs/
              formats: |-
                epub
                pdf
 
-See :ref:`NISTTHEDOCS2DEATH` for more information about configuration of
+See :ref:`DOCS4NIST` for more information about configuration of
 this workflow.
 
 .. toctree::
@@ -57,7 +57,7 @@ this workflow.
    :caption: Actions:
    :hidden:
 
-   nistthedocs2death
+   docs4nist
    ntd2d
 
 

diff --git a/docs/ntd2d.rst b/docs/ntd2d.rst
@@ -4,14 +4,14 @@
 ===========================
 
 This `GitHub action <https://docs.github.com/en/actions>`_ is invoked by
-the main :ref:`NISTTHEDOCS2DEATH` to move built documentation into your
+the main :ref:`DOCS4NIST` to move built documentation into your
 designated :ref:`PAGES_BRANCH`.
 
 Usage
 -----
 
 This action is invoked as a step of the composite workflow of the
-:ref:`NISTTHEDOCS2DEATH`.  There is no reason to invoke this action
+:ref:`DOCS4NIST`.  There is no reason to invoke this action
 yourself.
 
 .. code-block:: yaml
@@ -36,8 +36,8 @@ yourself.
 .. note::
 
    This action must be synchronized with the invoked version of the
-   :ref:`NISTTHEDOCS2DEATH`, but
-   "``usnistgov/NISTtheDocs2Death/borg_the_docs@${{ github.action_ref }}``"
+   :ref:`DOCS4NIST`, but
+   "``usnistgov/Docs4NIST/borg_the_docs@${{ github.action_ref }}``"
    `doesn't work
    <https://github.com/orgs/community/discussions/41927#discussioncomment-4605881>`_,
    hence the clumsy ``uses:`` statement.

diff --git a/ntd2d/Dockerfile b/ntd2d/Dockerfile
@@ -1,4 +1,4 @@
-FROM ghcr.io/usnistgov/nistthedocs2death:docker
+FROM ghcr.io/usnistgov/docs4nist:docker
 
 LABEL maintainer="Jonathan Guyer <guyer@nist.gov>"
 

diff --git a/ntd2d/README.md b/ntd2d/README.md
@@ -1,4 +1,4 @@
-# `NISTtheDocs2Death`: `ntd2d` Action
+# `Docs4NIST`: `ntd2d` Action
 
 This action is not intended to be called by users.  It is invoked by a
 GitHub action that uses sphinx to build documentation and then host on
@@ -58,7 +58,7 @@ runs:
     :
     :
     - name: Build documentation
-      uses: usnistgov/NISTtheDocs2Death/ntd2d@${{ github.action_ref }}
+      uses: usnistgov/Docs4NIST/ntd2d@${{ github.action_ref }}
       with:
     :
     :

diff --git a/ntd2d/ntd2d_action/files/templates/conf.py b/ntd2d/ntd2d_action/files/templates/conf.py
@@ -1,6 +1,6 @@
 {original_contents}
 
-# -- Injected automatically by NISTtheDocs2Death ------------------------------
+# -- Injected automatically by Docs4NIST ------------------------------
 
 html_theme = "{html_theme}"
 html_theme_path = {html_theme_path}

diff --git a/ntd2d/ntd2d_action/sphinxdocs.py b/ntd2d/ntd2d_action/sphinxdocs.py
@@ -124,7 +124,7 @@ def build_docs(self, build_command):
 
 
 class BorgedSphinxDocs(SphinxDocs):
-    """Sphinx configuration directory modified by NISTtheDocs2Death.
+    """Sphinx configuration directory modified by Docs4NIST
 
     Parameters
     ----------