From a699228b6447074b28b8b8d12cb341a02a013a40 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 12:43:59 -0400 Subject: [PATCH 1/6] Drop jira.lsstcorp.org from ignore list Since we'll stop using this domain, we can stop including it in the ignore list. --- src/documenteer/conf/guide.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/documenteer/conf/guide.py b/src/documenteer/conf/guide.py index 8d1e628..f5d40e6 100644 --- a/src/documenteer/conf/guide.py +++ b/src/documenteer/conf/guide.py @@ -234,9 +234,8 @@ linkcheck_retries = 2 -# Tucson IT infrastructure sometimes goes down or has TLS issues linkcheck_ignore = [ - r"^https://jira.lsstcorp.org/browse/", + # Tucson IT infrastructure sometimes goes down or has TLS issues r"^https://ls.st/", ] _conf.append_linkcheck_ignore(linkcheck_ignore) From abecdbacb911568e5707195bc4e041dc34d6243e Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 12:45:36 -0400 Subject: [PATCH 2/6] Change default of jira_uri to atlassian.net Update default for the jira_uri_template configuration to https://rubinobs.atlassian.net/browse/{ticket} This will make all :jira:, :jirab:, and :jirap: roles point to the new Jira. --- src/documenteer/ext/jira.py | 2 +- tests/ext/jira_test.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/documenteer/ext/jira.py b/src/documenteer/ext/jira.py index fde7d05..3d3fc5f 100644 --- a/src/documenteer/ext/jira.py +++ b/src/documenteer/ext/jira.py @@ -153,7 +153,7 @@ def jira_parens_role( def setup(app): app.add_config_value( "jira_uri_template", - default="https://jira.lsstcorp.org/browse/{ticket}", + default="https://rubinobs.atlassian.net/browse/{ticket}", rebuild="html", ) app.add_role("jira", jira_role) diff --git a/tests/ext/jira_test.py b/tests/ext/jira_test.py index e532e36..0dafb03 100644 --- a/tests/ext/jira_test.py +++ b/tests/ext/jira_test.py @@ -18,7 +18,7 @@ from mock import Mock -URI = "https://jira.lsstcorp.org/browse/{ticket}" +URI = "https://rubinobs.atlassian.net/browse/{ticket}" @pytest.fixture() From 430c1548c4e0fe611595379e6d5d4ea04adaabfd Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 13:00:32 -0400 Subject: [PATCH 3/6] Replace jira.lsstcorp.org URLs Replace remaining instances of the jira.lsstcorp.org URLs with the new location at rubinobs.atlassian.net. --- CHANGELOG.md | 36 +++++++++++------------ docs/sphinx-extensions/jira-reference.rst | 2 +- src/documenteer/conf/pipelines.py | 2 +- tests/test_conf_toml.py | 4 +-- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe5aa27..3d72de8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -340,7 +340,7 @@ Fixes: - Individual Stack packages now import `documenteer.conf.pipelinespkg` in their `conf.py` files. The previous configuration sub-package, `documenteer.sphinxconf` is deprecated. - [[DM-20866](https://jira.lsstcorp.org/browse/DM-20866)] + [[DM-20866](https://rubinobs.atlassian.net/browse/DM-20866)] Overall, the configurations are compatible with these exceptions: @@ -363,13 +363,13 @@ Fixes: For example, individual packages can add to the `EXCLUDE` tag. By default, each package's `include` directory is included in the Doxygen build. - [[DM-22698](https://jira.lsstcorp.org/browse/DM-22698), [DM-23094](https://jira.lsstcorp.org/browse/DM-23094), [DM-22461](https://jira.lsstcorp.org/browse/DM-22461)] + [[DM-22698](https://rubinobs.atlassian.net/browse/DM-22698), [DM-23094](https://rubinobs.atlassian.net/browse/DM-23094), [DM-22461](https://rubinobs.atlassian.net/browse/DM-22461)] - Improved Sphinx runner (`documenteer.sphinxrunner`). - [[DM-26768](https://jira.lsstcorp.org/browse/DM-26768)] + [[DM-26768](https://rubinobs.atlassian.net/browse/DM-26768)] - Added static type checking using [mypy](https://mypy.readthedocs.io/en/stable/). - [[DM-22717](https://jira.lsstcorp.org/browse/DM-22717), [DM-26288](https://jira.lsstcorp.org/browse/DM-26288)] + [[DM-22717](https://rubinobs.atlassian.net/browse/DM-22717), [DM-26288](https://rubinobs.atlassian.net/browse/DM-26288)] - Improved packaging, testing, and development environment: @@ -381,7 +381,7 @@ Fixes: - Migrated to `pre-commit` for running linters and code formatters. - Migrated to GitHub Actions from Travis CI. - [`DM-22957 `_, `DM-26288 `_] + [`DM-22957 `_, `DM-26288 `_] - Documentation improvements: @@ -396,19 +396,19 @@ Fixes: - Technote configuration now uses `yaml.safe_load` instead of `yaml.load`. See the [pyyaml docs for details](https://github.com/yaml/pyyaml/wiki/PyYAML-yaml.load(input)-Deprecation). - [[DM-22537](https://jira.lsstcorp.org/browse/DM-22537)] + [[DM-22537](https://rubinobs.atlassian.net/browse/DM-22537)] ## 0.5.4 (2019-11-03) - This new version of the technote sphinx theme should fix the edition link in the sidebar for non-main editions. - [[DM-20839](https://jira.lsstcorp.org/browse/DM-20839)] + [[DM-20839](https://rubinobs.atlassian.net/browse/DM-20839)] ## 0.5.3 (2019-08-07) - Enabled the `html_use_index` and `html_domain_indices` configurations for Stack documentation projects to enable automatic index generation. The `genindex` contains links to all command-line options and Python objects (Sphinx's domains). This also opens us up to a more general content index by way of the [index directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#index-generating-markup). - [[DM-20850](https://jira.lsstcorp.org/browse/DM-20850)] + [[DM-20850](https://rubinobs.atlassian.net/browse/DM-20850)] - Fixed compatibility with docutils 0.15. Now Sphinx will control which version of docutils is used, which should now be 0.15. @@ -419,7 +419,7 @@ Fixes: - Add [sphinxcontrib.autoprogram](https://sphinxcontrib-autoprogram.readthedocs.io/en/stable/) to enable automated reference documentation of argparse-based command-line scripts. This extension is available with the `documenteer[pipelines]` installation extra and enabled by default for LSST Science Pipelines projects. - [[DM-20767](https://jira.lsstcorp.org/browse/)] + [[DM-20767](https://rubinobs.atlassian.net/browse/)] - Update the official list of tested and supported Python versions to Python 3.6 and 3.7. @@ -433,7 +433,7 @@ Fixes: - The stack documentation build now requires that packages be explicitly required by the main documentation project's EUPS table file. Before, a package only needed a `doc/manifest.yaml` file and to be currently set up in the EUPS environment to be linked into the documentation build. This would lead to packages being included in a documentation build despite not being a part of that stack product. - [[DM-17765](https://jira.lsstcorp.org/browse/DM-17765)] + [[DM-17765](https://rubinobs.atlassian.net/browse/DM-17765)] - This release adds the [sphinx-jinja](https://github.com/tardyp/sphinx-jinja) extension for `documenteer[pipelines]` installations. This extension makes it possible to dynamically create content with Jinja templating. @@ -453,7 +453,7 @@ Fixes: - `pipelines_demo_ref` These variables are accessible from the `jinja` directive's context. - [[DM-17065](https://jira.lsstcorp.org/browse/DM-17065)] + [[DM-17065](https://rubinobs.atlassian.net/browse/DM-17065)] - This release also added some new substitutions to the `rst_epilog` of stack-based projects: @@ -467,7 +467,7 @@ Fixes: - The project's name is also used as the `logotext` at the top of the page for stack-based projects. Previously the `logotext` would always be "LSST Science Pipelines." - [[DM-17263](https://jira.lsstcorp.org/browse/DM-17263)] + [[DM-17263](https://rubinobs.atlassian.net/browse/DM-17263)] - Added the following projects to the intersphinx inventory of stack-based projects: @@ -481,18 +481,18 @@ Fixes: ## 0.4.4 (2019-02-05) - Updated scikit-learn's intersphinx inventory URL (now available as HTTPS) in the `documenteer.sphinxconfig.stackconf`. -- Fixed the `lsst-task-config-subtasks` directive so that it can introspect items in an `lsst.pex.config` `Registry` that are wrapped by a `ConfigurableWrapper`. [(DM-17661)[https://jira.lsstcorp.org/browse/DM-17661]] +- Fixed the `lsst-task-config-subtasks` directive so that it can introspect items in an `lsst.pex.config` `Registry` that are wrapped by a `ConfigurableWrapper`. [(DM-17661)[https://rubinobs.atlassian.net/browse/DM-17661]] ## 0.4.3 (2018-11-30) - Pin [sphinxcontrib-bibtex](https://github.com/mcmtroffaes/sphinxcontrib-bibtex) to version 0.4.0 since later versions are incompatible with Sphinx <1.8.0. - [[DM-16651](https://jira.lsstcorp.org/browse/DM-16651)] + [[DM-16651](https://rubinobs.atlassian.net/browse/DM-16651)] ## 0.4.2 (2018-11-01) - Handle cases where an object does not have a docstring in `documenteer.sphinxext.lssttasks.taskutils.get_docstring`. This improves the reliability of the `lsst-task-api-summary` directive. - See (DM-16102)(https://jira.lsstcorp.org/browse/DM-16102). + See (DM-16102)(https://rubinobs.atlassian.net/browse/DM-16102). ## 0.4.1 (2018-10-15) @@ -521,7 +521,7 @@ Fixes: This configuration is critical: 1. It is actually responsible for ensuring that inherited members of classes appear in our docs. - 2. Without this, classes that have a `__slots__` attribute (typically through inheritance of a `collections.abc` class) won't have *any* of their members documented. See (DM-16102)(https://jira.lsstcorp.org/browse/DM-16102) for discussion. + 2. Without this, classes that have a `__slots__` attribute (typically through inheritance of a `collections.abc` class) won't have *any* of their members documented. See (DM-16102)(https://rubinobs.atlassian.net/browse/DM-16102) for discussion. - `todo` directives are now hidden when using `build_pipelines_lsst_io_configs`. They are still shown, by default, for standalone package documentation builds, which are primarily developer-facing. @@ -650,7 +650,7 @@ Fixes: ## 0.1.10 (2016-12-14) -Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 `__: +Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 `__: - Added dependencies to [breathe](http://breathe.readthedocs.io/en/latest/), [astropy-helpers](https://github.com/astropy/astropy-helpers) and the [lsst-sphinx-bootstrap-theme](https://github.com/lsst-sqre/lsst-sphinx-bootstrap-theme) to generally coordinate LSST Science Pipelines documentation dependencies. - Created `documenteer.sphinxconfig.stackconf` module to centrally coordinate Science Pipelines documentation configuration. Much of the configuration is based on [astropy-helper's Sphinx configuration](https://github.com/astropy/astropy-helpers/blob/master/astropy_helpers/sphinx/conf.py) since the LSST Science Pipelines documentation is heavily based upon Astropy's Sphinx theme and API reference generation infrastructure. @@ -685,7 +685,7 @@ Includes prototype support for LSST Science Pipelines documentation, as part of ## 0.1.3 (2016-05-24) -- Add roles for linking to ls.st links: `lpm`, `ldm`, and `lse`. DM-6181. +- Add roles for linking to `ls.st` links: `lpm`, `ldm`, and `lse`. DM-6181. - Add roles for linking to JIRA tickets: `jira`, `jirab`, and `jirap`. DM-6181. ## 0.1.2 (2016-05-14) diff --git a/docs/sphinx-extensions/jira-reference.rst b/docs/sphinx-extensions/jira-reference.rst index 9052a33..0f96f4f 100644 --- a/docs/sphinx-extensions/jira-reference.rst +++ b/docs/sphinx-extensions/jira-reference.rst @@ -4,7 +4,7 @@ Jira reference roles #################### -Documenteer provides reStructuredText roles to simplify linking to issues in LSST's Jira ticketing system at https://jira.lsstcorp.org. +Documenteer provides reStructuredText roles to simplify linking to issues in LSST's Jira ticketing system at https://rubinobs.atlassian.net. To use these roles, add the ``documenteer.ext.jira`` extension to your :file:`conf.py` file: diff --git a/src/documenteer/conf/pipelines.py b/src/documenteer/conf/pipelines.py index 0484ba7..4d9e935 100644 --- a/src/documenteer/conf/pipelines.py +++ b/src/documenteer/conf/pipelines.py @@ -150,7 +150,7 @@ # methods. # NOTE: We want to used `inherited-members`, but it seems to be causing # documentation duplication in the automodapi listings. We're leaving -# this out for now. See https://jira.lsstcorp.org/browse/DM-14782 for +# this out for now. See https://rubinobs.atlassian.net/browse/DM-14782 for # additional notes. # NOTE: Without inherited members set, special-members doesn't need seem # to have an effect (even for special members where the docstrings are diff --git a/tests/test_conf_toml.py b/tests/test_conf_toml.py index 7dceb27..509ac8a 100644 --- a/tests/test_conf_toml.py +++ b/tests/test_conf_toml.py @@ -139,12 +139,12 @@ def test_append_linkcheck_ignore() -> None: config = DocumenteerConfig.load(EXAMPLE) linkcheck_ignore = [ - r"^https://jira.lsstcorp.org/browse/", + r"^https://rubinobs.atlassian.net/browse/", r"^https://ls.st/", ] config.append_linkcheck_ignore(linkcheck_ignore) assert linkcheck_ignore == [ - r"^https://jira.lsstcorp.org/browse/", + r"^https://rubinobs.atlassian.net/browse/", r"^https://ls.st/", r"^https://confluence.lsstcorp.org/", ] From 88221c940e4b803590e2c93ab4b467d105c6897d Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 13:05:06 -0400 Subject: [PATCH 4/6] Add changelog entry for Jira URL update --- changelog.d/20240411_130215_jsick_DM_43749.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 changelog.d/20240411_130215_jsick_DM_43749.md diff --git a/changelog.d/20240411_130215_jsick_DM_43749.md b/changelog.d/20240411_130215_jsick_DM_43749.md new file mode 100644 index 0000000..c84d083 --- /dev/null +++ b/changelog.d/20240411_130215_jsick_DM_43749.md @@ -0,0 +1,5 @@ +### Bug fixes + +- Update `jira_uri_template` configuration default to `https://rubinobs.atlassian.net/browse/{issue}`. This will make all :jira:, :jirab:, and :jirap: roles point to the new Jira instance for Rubin Observatory. +- Drop `jira.lsstcorp.org` from the linkcheck ignore list defaults for `documenteer.config.guide` since that instance is no longer being used. +- Replace `jira.lsstcorp.org` URLs in documentation to `rubinobs.atlassian.net`. From f82d97f4538f858b8f9068a8365c1c5f8ffbb1f8 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 14:18:09 -0400 Subject: [PATCH 5/6] Change demo citation It seems that 2017arXiv170309824V might have dropped from lsst-texmf? --- demo/ipynb-technote/index.ipynb | 2 +- demo/md-technote/index.md | 2 +- demo/rst-technote/index.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/demo/ipynb-technote/index.ipynb b/demo/ipynb-technote/index.ipynb index ec0b92e..a99cd29 100644 --- a/demo/ipynb-technote/index.ipynb +++ b/demo/ipynb-technote/index.ipynb @@ -21,7 +21,7 @@ "\n", "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n", "\n", - "A parenthetical citation {cite:p}`2017arXiv170309824V`. And a textual citation {cite:t}`2017arXiv170309824V`." + "A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`." ] }, { diff --git a/demo/md-technote/index.md b/demo/md-technote/index.md index 526accb..612281a 100644 --- a/demo/md-technote/index.md +++ b/demo/md-technote/index.md @@ -10,7 +10,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetr Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo. -A parenthetical citation {cite:p}`2017arXiv170309824V`. And a textual citation {cite:t}`2017arXiv170309824V`. +A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`. ## Method diff --git a/demo/rst-technote/index.rst b/demo/rst-technote/index.rst index cad31bb..ad55a91 100644 --- a/demo/rst-technote/index.rst +++ b/demo/rst-technote/index.rst @@ -16,7 +16,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetr Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo. -A parenthetical citation :cite:p:`2017arXiv170309824V`. And a textual citation :cite:t:`2017arXiv170309824V`. +A parenthetical citation :cite:p:`SQR-083`. And a textual citation :cite:t:`SQR-083`. Method ====== From e0f3e1082b555a97647c47bb019a24c917d0a419 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Thu, 11 Apr 2024 14:44:32 -0400 Subject: [PATCH 6/6] Prepare change log for 1.2.2 release --- CHANGELOG.md | 9 +++++++++ changelog.d/20240411_130215_jsick_DM_43749.md | 5 ----- 2 files changed, 9 insertions(+), 5 deletions(-) delete mode 100644 changelog.d/20240411_130215_jsick_DM_43749.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d72de8..a12791b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ + +## 1.2.2 (2024-04-11) + +### Bug fixes + +- Update `jira_uri_template` configuration default to `https://rubinobs.atlassian.net/browse/{issue}`. This will make all :jira:, :jirab:, and :jirap: roles point to the new Jira instance for Rubin Observatory. +- Drop `jira.lsstcorp.org` from the linkcheck ignore list defaults for `documenteer.config.guide` since that instance is no longer being used. +- Replace `jira.lsstcorp.org` URLs in documentation to `rubinobs.atlassian.net`. + ## 1.2.1 (2024-04-02) diff --git a/changelog.d/20240411_130215_jsick_DM_43749.md b/changelog.d/20240411_130215_jsick_DM_43749.md deleted file mode 100644 index c84d083..0000000 --- a/changelog.d/20240411_130215_jsick_DM_43749.md +++ /dev/null @@ -1,5 +0,0 @@ -### Bug fixes - -- Update `jira_uri_template` configuration default to `https://rubinobs.atlassian.net/browse/{issue}`. This will make all :jira:, :jirab:, and :jirap: roles point to the new Jira instance for Rubin Observatory. -- Drop `jira.lsstcorp.org` from the linkcheck ignore list defaults for `documenteer.config.guide` since that instance is no longer being used. -- Replace `jira.lsstcorp.org` URLs in documentation to `rubinobs.atlassian.net`.