documenteer 1.2.0__tar.gz → 1.2.2__tar.gz

{documenteer-1.2.0 → documenteer-1.2.2}/.github/workflows/ci-cron.yaml

@@ -41,11 +41,16 @@ jobs:
           npm install
           npm run build
 
+      - name: Install graphviz
+        run: |
+          sudo apt-get update
+          sudo apt-get install graphviz
+
       - name: Run tests in tox
         uses: lsst-sqre/run-tox@v1
         with:
           python-version: ${{ matrix.python-version }}
-          tox-envs: "lint,typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }}"
+          tox-envs: "lint,typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
           use-cache: false
 
   docs:

{documenteer-1.2.0 → documenteer-1.2.2}/.github/workflows/ci.yaml

@@ -61,11 +61,16 @@ jobs:
           npm install
           npm run build
 
+      - name: Install graphviz
+        run: |
+          sudo apt-get update
+          sudo apt-get install graphviz
+
       - name: Run tox
         uses: lsst-sqre/run-tox@v1
         with:
           python-version: ${{ matrix.python-version }}
-          tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }}'
+          tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
 
   docs:
     runs-on: ubuntu-latest

{documenteer-1.2.0 → documenteer-1.2.2}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-1.2.2'></a>
+## 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`.
+
+<a id='changelog-1.2.1'></a>
+## 1.2.1 (2024-04-02)
+
+### Bug fixes
+
+- Fix the "Source parser for markdown not registered" error for Markdown-based technotes. With the MyST-NB extension the Markdown parser is automatically registered, so the `documenteer.conf.technote` configuration now resets the `source_suffix` configuration originally created by the Technote package.
+
 <a id='changelog-1.2.0'></a>
 ## 1.2.0 (2024-03-26)
 
@@ -333,7 +349,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:
 
@@ -356,13 +372,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:
 
@@ -374,7 +390,7 @@ Fixes:
   - Migrated to `pre-commit` for running linters and code formatters.
   - Migrated to GitHub Actions from Travis CI.
 
-  [`DM-22957 <https://jira.lsstcorp.org/browse/DM-22957>`_, `DM-26288 <https://jira.lsstcorp.org/browse/DM-26288>`_]
+  [`DM-22957 <https://rubinobs.atlassian.net/browse/DM-22957>`_, `DM-26288 <https://rubinobs.atlassian.net/browse/DM-26288>`_]
 
 - Documentation improvements:
 
@@ -389,19 +405,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.
@@ -412,7 +428,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.
 
@@ -426,7 +442,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.
@@ -446,7 +462,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:
 
@@ -460,7 +476,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:
 
@@ -474,18 +490,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)
 
@@ -514,7 +530,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.
@@ -643,7 +659,7 @@ Fixes:
 
 ## 0.1.10 (2016-12-14)
 
-Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://jira.lsstcorp.org/browse/DM-6199>`__:
+Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://rubinobs.atlassian.net/browse/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.
@@ -678,7 +694,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)

{documenteer-1.2.0 → documenteer-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: documenteer
-Version: 1.2.0
+Version: 1.2.2
 Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
 License: The MIT License (MIT)
         

{documenteer-1.2.0 → documenteer-1.2.2}/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`."
    ]
   },
   {

documenteer-1.2.2/demo/md-technote/index.md

@@ -0,0 +1,73 @@
+# Demo technote
+
+```{abstract}
+A *technote* is a web-native single page document that enables rapid technical communication within and across teams.
+```
+
+## Introduction
+
+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.
+
+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}`SQR-083`. And a textual citation {cite:t}`SQR-083`.
+
+## Method
+
+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 list:
+
+- First item
+- Second item
+- Third item
+
+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.
+
+```{code-block} python
+:caption: hello.py
+
+print("Hello world")
+```
+
+## Results
+
+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.
+
+### Subsection
+
+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.
+
+#### Subsubsection
+
+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.
+
+## Analysis
+
+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.
+
+```{prompt} bash
+git add index.rst
+```
+
+Some following text.
+
+```{mermaid}
+graph TD
+   A[Square Rect] -- Link text --> B((Circle))
+   A --> C(Round Rect)
+   B --> D{Rhombus}
+   C --> D
+```
+
+```{diagrams} diagram.py
+```
+
+## Conclusion
+
+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.
+
+## References
+
+```{bibliography}
+```

documenteer-1.2.2/demo/rst-technote/.gitignore

@@ -0,0 +1,2 @@
+_build
+.technote

documenteer-1.2.2/demo/rst-technote/Makefile

@@ -0,0 +1,3 @@
+.PHONY:
+clean:
+	rm -rf _build

documenteer-1.2.2/demo/rst-technote/conf.py

@@ -0,0 +1 @@
+from documenteer.conf.technote import *  # noqa F401 F403

documenteer-1.2.2/demo/rst-technote/diagram.py

@@ -0,0 +1,14 @@
+from diagrams.k8s.clusterconfig import HPA
+from diagrams.k8s.compute import Deployment, Pod, ReplicaSet
+from diagrams.k8s.network import Ingress, Service
+from sphinx_diagrams import SphinxDiagram
+
+with SphinxDiagram(title="GKE"):
+    net = Ingress("domain.com") >> Service("svc")
+    (
+        net
+        >> [Pod("pod1"), Pod("pod2"), Pod("pod3")]
+        << ReplicaSet("rs")
+        << Deployment("dp")
+        << HPA("hpa")
+    )

{documenteer-1.2.0 → documenteer-1.2.2}/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
 ======

documenteer-1.2.2/demo/rst-technote/technote.toml

@@ -0,0 +1,25 @@
+[technote]
+id = "SQR-000"
+series_id = "SQR"
+canonical_url = "https://sqr-000.lsst.io"
+github_url = "https://github.com/lsst-sqre/sqr-000"
+github_default_branch = "master"
+date_created = 2015-11-18
+date_updated = 2015-11-23
+version = "1.0.0"
+
+[[technote.authors]]
+name.given = "Jonathan"
+name.family = "Sick"
+orcid = "https://orcid.org/0000-0003-3001-676X"
+affiliations = [
+    { name = "Rubin Observatory", ror = "https://ror.org/048g3cy84" }
+]
+
+[[technote.authors]]
+name.given = "Frossie"
+name.family = "Economou"
+
+[[technote.authors]]
+name.given = "Russ"
+name.family = "Allbery"

{documenteer-1.2.0 → documenteer-1.2.2}/docs/changelog.md

@@ -2,6 +2,22 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-1.2.2'></a>
+## 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`.
+
+<a id='changelog-1.2.1'></a>
+## 1.2.1 (2024-04-02)
+
+### Bug fixes
+
+- Fix the "Source parser for markdown not registered" error for Markdown-based technotes. With the MyST-NB extension the Markdown parser is automatically registered, so the `documenteer.conf.technote` configuration now resets the `source_suffix` configuration originally created by the Technote package.
+
 <a id='changelog-1.2.0'></a>
 ## 1.2.0 (2024-03-26)
 
@@ -333,7 +349,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:
 
@@ -356,13 +372,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:
 
@@ -374,7 +390,7 @@ Fixes:
   - Migrated to `pre-commit` for running linters and code formatters.
   - Migrated to GitHub Actions from Travis CI.
 
-  [`DM-22957 <https://jira.lsstcorp.org/browse/DM-22957>`_, `DM-26288 <https://jira.lsstcorp.org/browse/DM-26288>`_]
+  [`DM-22957 <https://rubinobs.atlassian.net/browse/DM-22957>`_, `DM-26288 <https://rubinobs.atlassian.net/browse/DM-26288>`_]
 
 - Documentation improvements:
 
@@ -389,19 +405,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.
@@ -412,7 +428,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.
 
@@ -426,7 +442,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.
@@ -446,7 +462,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:
 
@@ -460,7 +476,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:
 
@@ -474,18 +490,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)
 
@@ -514,7 +530,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.
@@ -643,7 +659,7 @@ Fixes:
 
 ## 0.1.10 (2016-12-14)
 
-Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://jira.lsstcorp.org/browse/DM-6199>`__:
+Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://rubinobs.atlassian.net/browse/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.
@@ -678,7 +694,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)

{documenteer-1.2.0 → documenteer-1.2.2}/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:
 

{documenteer-1.2.0 → documenteer-1.2.2}/src/documenteer/conf/guide.py

@@ -234,9 +234,8 @@ intersphinx_cache_limit = 5  # days
 
 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)

{documenteer-1.2.0 → documenteer-1.2.2}/src/documenteer/conf/pipelines.py

@@ -150,7 +150,7 @@ autoclass_content = "class"
 # 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

{documenteer-1.2.0 → documenteer-1.2.2}/src/documenteer/conf/technote.py

@@ -43,6 +43,12 @@ extensions.extend(  # noqa: F405
     ]
 )
 
+# The source file suffixes for .md and .ipynb are automatically managed by
+# myst-nb.
+source_suffix = {
+    ".rst": "restructuredtext",
+}
+
 html_static_path: list[str] = [
     get_asset_path("rubin-favicon-transparent-32px.png"),
     get_asset_path("rubin-favicon.svg"),

{documenteer-1.2.0 → documenteer-1.2.2}/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)

{documenteer-1.2.0 → documenteer-1.2.2}/src/documenteer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: documenteer
-Version: 1.2.0
+Version: 1.2.2
 Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
 License: The MIT License (MIT)
         

{documenteer-1.2.0 → documenteer-1.2.2}/src/documenteer.egg-info/SOURCES.txt

@@ -32,6 +32,12 @@ demo/ipynb-technote/conf.py
 demo/ipynb-technote/diagram.py
 demo/ipynb-technote/index.ipynb
 demo/ipynb-technote/technote.toml
+demo/md-technote/.gitignore
+demo/md-technote/Makefile
+demo/md-technote/conf.py
+demo/md-technote/diagram.py
+demo/md-technote/index.md
+demo/md-technote/technote.toml
 demo/rst-technote/.gitignore
 demo/rst-technote/Makefile
 demo/rst-technote/conf.py

{documenteer-1.2.0 → documenteer-1.2.2}/tests/ext/jira_test.py

@@ -18,7 +18,7 @@ except ImportError:
     from mock import Mock
 
 
-URI = "https://jira.lsstcorp.org/browse/{ticket}"
+URI = "https://rubinobs.atlassian.net/browse/{ticket}"
 
 
 @pytest.fixture()

{documenteer-1.2.0 → documenteer-1.2.2}/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/",
     ]