documenteer 1.2.1__tar.gz → 1.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (254) hide show
  1. {documenteer-1.2.1 → documenteer-1.2.2}/CHANGELOG.md +27 -18
  2. {documenteer-1.2.1 → documenteer-1.2.2}/PKG-INFO +1 -1
  3. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/index.ipynb +1 -1
  4. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/index.md +1 -1
  5. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/index.rst +1 -1
  6. {documenteer-1.2.1 → documenteer-1.2.2}/docs/changelog.md +27 -18
  7. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/jira-reference.rst +1 -1
  8. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/guide.py +1 -2
  9. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/pipelines.py +1 -1
  10. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/jira.py +1 -1
  11. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/PKG-INFO +1 -1
  12. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/jira_test.py +1 -1
  13. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_conf_toml.py +2 -2
  14. {documenteer-1.2.1 → documenteer-1.2.2}/.flake8 +0 -0
  15. {documenteer-1.2.1 → documenteer-1.2.2}/.github/CODE_OF_CONDUCT.md +0 -0
  16. {documenteer-1.2.1 → documenteer-1.2.2}/.github/CONTRIBUTING.md +0 -0
  17. {documenteer-1.2.1 → documenteer-1.2.2}/.github/SUPPORT.md +0 -0
  18. {documenteer-1.2.1 → documenteer-1.2.2}/.github/dependabot.yml +0 -0
  19. {documenteer-1.2.1 → documenteer-1.2.2}/.github/workflows/ci-cron.yaml +0 -0
  20. {documenteer-1.2.1 → documenteer-1.2.2}/.github/workflows/ci.yaml +0 -0
  21. {documenteer-1.2.1 → documenteer-1.2.2}/.github/workflows/dependencies.yaml +0 -0
  22. {documenteer-1.2.1 → documenteer-1.2.2}/.gitignore +0 -0
  23. {documenteer-1.2.1 → documenteer-1.2.2}/.npmrc +0 -0
  24. {documenteer-1.2.1 → documenteer-1.2.2}/.nvmrc +0 -0
  25. {documenteer-1.2.1 → documenteer-1.2.2}/.pre-commit-config.yaml +0 -0
  26. {documenteer-1.2.1 → documenteer-1.2.2}/.prettierignore +0 -0
  27. {documenteer-1.2.1 → documenteer-1.2.2}/.prettierrc.yaml +0 -0
  28. {documenteer-1.2.1 → documenteer-1.2.2}/.vscode/settings.json +0 -0
  29. {documenteer-1.2.1 → documenteer-1.2.2}/.vscode/tasks.json +0 -0
  30. {documenteer-1.2.1 → documenteer-1.2.2}/LICENSE +0 -0
  31. {documenteer-1.2.1 → documenteer-1.2.2}/MANIFEST.in +0 -0
  32. {documenteer-1.2.1 → documenteer-1.2.2}/Makefile +0 -0
  33. {documenteer-1.2.1 → documenteer-1.2.2}/README.md +0 -0
  34. {documenteer-1.2.1 → documenteer-1.2.2}/changelog.d/_template.md.jinja +0 -0
  35. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/.gitignore +0 -0
  36. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/Makefile +0 -0
  37. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/conf.py +0 -0
  38. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/diagram.py +0 -0
  39. {documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/technote.toml +0 -0
  40. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/.gitignore +0 -0
  41. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/Makefile +0 -0
  42. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/conf.py +0 -0
  43. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/diagram.py +0 -0
  44. {documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/technote.toml +0 -0
  45. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/.gitignore +0 -0
  46. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/Makefile +0 -0
  47. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/conf.py +0 -0
  48. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/diagram.py +0 -0
  49. {documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/technote.toml +0 -0
  50. {documenteer-1.2.1 → documenteer-1.2.2}/docs/.gitignore +0 -0
  51. {documenteer-1.2.1 → documenteer-1.2.2}/docs/Makefile +0 -0
  52. {documenteer-1.2.1 → documenteer-1.2.2}/docs/_rst_epilog.rst +0 -0
  53. {documenteer-1.2.1 → documenteer-1.2.2}/docs/conf.py +0 -0
  54. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/documenteer.conf.rst +0 -0
  55. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/documenteer.ext.rst +0 -0
  56. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/documenteer.requestsutils.rst +0 -0
  57. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/documenteer.sphinxrunner.rst +0 -0
  58. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/documenteer.stackdocs.rst +0 -0
  59. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/api/index.rst +0 -0
  60. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/development.rst +0 -0
  61. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/html-templates.rst +0 -0
  62. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/index.rst +0 -0
  63. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/release.rst +0 -0
  64. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/theme-assets.rst +0 -0
  65. {documenteer-1.2.1 → documenteer-1.2.2}/docs/dev/theme.rst +0 -0
  66. {documenteer-1.2.1 → documenteer-1.2.2}/docs/documenteer.toml +0 -0
  67. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/badges.rst +0 -0
  68. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/configuration-preset.rst +0 -0
  69. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/configuration.rst +0 -0
  70. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/diagrams.rst +0 -0
  71. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/extend-conf-py.rst +0 -0
  72. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/including-notebooks.ipynb +0 -0
  73. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/index.rst +0 -0
  74. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/markdown-primer.md +0 -0
  75. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/openapi.rst +0 -0
  76. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/organization.rst +0 -0
  77. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/overview.rst +0 -0
  78. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/build-overview.rst +0 -0
  79. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/configuration.rst +0 -0
  80. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/cpp-api-linking.rst +0 -0
  81. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/index.rst +0 -0
  82. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/install.rst +0 -0
  83. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/package-docs-cli.rst +0 -0
  84. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pipelines/stack-docs-cli.rst +0 -0
  85. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/pyproject-configuration.rst +0 -0
  86. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/rst-epilog.rst +0 -0
  87. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/tabsets.rst +0 -0
  88. {documenteer-1.2.1 → documenteer-1.2.2}/docs/guides/toml-reference.rst +0 -0
  89. {documenteer-1.2.1 → documenteer-1.2.2}/docs/index.rst +0 -0
  90. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/autocppapi.rst +0 -0
  91. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/autodocreset.rst +0 -0
  92. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  93. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  94. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/index.rst +0 -0
  95. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  96. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/lssttasks.rst +0 -0
  97. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/openapi.rst +0 -0
  98. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/package-toctree.rst +0 -0
  99. {documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  100. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/_templates/README.md +0 -0
  101. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/_templates/README.rst +0 -0
  102. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/author-metadata.rst +0 -0
  103. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/configuration.rst +0 -0
  104. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/document-status.rst +0 -0
  105. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/edit-locally.rst +0 -0
  106. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/edit-on-github.rst +0 -0
  107. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/extensions.rst +0 -0
  108. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  109. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/index.rst +0 -0
  110. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/migrate.rst +0 -0
  111. {documenteer-1.2.1 → documenteer-1.2.2}/docs/technotes/start-a-technote.rst +0 -0
  112. {documenteer-1.2.1 → documenteer-1.2.2}/licenses/README.md +0 -0
  113. {documenteer-1.2.1 → documenteer-1.2.2}/licenses/astropy-helpers.txt +0 -0
  114. {documenteer-1.2.1 → documenteer-1.2.2}/licenses/sphinx-issue.txt +0 -0
  115. {documenteer-1.2.1 → documenteer-1.2.2}/licenses/sphinx.txt +0 -0
  116. {documenteer-1.2.1 → documenteer-1.2.2}/package-lock.json +0 -0
  117. {documenteer-1.2.1 → documenteer-1.2.2}/package.json +0 -0
  118. {documenteer-1.2.1 → documenteer-1.2.2}/postcss.config.js +0 -0
  119. {documenteer-1.2.1 → documenteer-1.2.2}/pyproject.toml +0 -0
  120. {documenteer-1.2.1 → documenteer-1.2.2}/setup.cfg +0 -0
  121. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  122. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  123. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  124. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/_properties.scss +0 -0
  125. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  126. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  127. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  128. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  129. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  130. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  131. {documenteer-1.2.1 → documenteer-1.2.2}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  132. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/__init__.py +0 -0
  133. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/.gitignore +0 -0
  134. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  135. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  136. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/favicon.ico +0 -0
  137. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  138. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  139. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  140. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-favicon.svg +0 -0
  141. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-pydata-theme.css +0 -0
  142. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-technote.css +0 -0
  143. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-technote.css.map +0 -0
  144. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  145. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  146. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  147. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  148. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/cli.py +0 -0
  149. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/__init__.py +0 -0
  150. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/_toml.py +0 -0
  151. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/_utils.py +0 -0
  152. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/pipelinespkg.py +0 -0
  153. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/technote.py +0 -0
  154. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/__init__.py +0 -0
  155. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/_utils.py +0 -0
  156. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/autocppapi.py +0 -0
  157. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/autodocreset.py +0 -0
  158. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/bibtex.py +0 -0
  159. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/githubbibcache.py +0 -0
  160. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lsstdocushare.py +0 -0
  161. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/__init__.py +0 -0
  162. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/configfieldlists.py +0 -0
  163. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/crossrefs.py +0 -0
  164. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/pyapisummary.py +0 -0
  165. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/taskutils.py +0 -0
  166. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/topiclists.py +0 -0
  167. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/lssttasks/topics.py +0 -0
  168. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/mockcoderefs.py +0 -0
  169. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/openapi.py +0 -0
  170. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/packagetoctree.py +0 -0
  171. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/remotecodeblock.py +0 -0
  172. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/packagemetadata.py +0 -0
  173. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/py.typed +0 -0
  174. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/requestsutils.py +0 -0
  175. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/services/__init__.py +0 -0
  176. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/services/technoteauthor.py +0 -0
  177. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/services/technotemigration.py +0 -0
  178. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/sphinxrunner.py +0 -0
  179. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/__init__.py +0 -0
  180. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/build.py +0 -0
  181. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -0
  182. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -0
  183. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/data/mainpage.dox +0 -0
  184. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/doxygen.py +0 -0
  185. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/doxygentag.py +0 -0
  186. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/packagecli.py +0 -0
  187. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/pkgdiscovery.py +0 -0
  188. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/rootdiscovery.py +0 -0
  189. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/stackdocs/stackcli.py +0 -0
  190. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/__init__.py +0 -0
  191. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/authordb.py +0 -0
  192. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/latex.py +0 -0
  193. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  194. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  195. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  196. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
  197. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  198. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  199. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  200. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  201. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  202. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/localtemplates.py +0 -0
  203. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/storage/technotetoml.py +0 -0
  204. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/pydata/layout.html +0 -0
  205. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/.gitkeep +0 -0
  206. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  207. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  208. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  209. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  210. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  211. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/utils.py +0 -0
  212. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/version.py +0 -0
  213. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/SOURCES.txt +0 -0
  214. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/dependency_links.txt +0 -0
  215. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/entry_points.txt +0 -0
  216. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/requires.txt +0 -0
  217. {documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/top_level.txt +0 -0
  218. {documenteer-1.2.1 → documenteer-1.2.2}/tests/conftest.py +0 -0
  219. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/afw.doxygen.conf +0 -0
  220. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/authordb.yaml +0 -0
  221. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/doxygen.tag.zip +0 -0
  222. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  223. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  224. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  225. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  226. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  227. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/include/README.md +0 -0
  228. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_alpha/src/README.md +0 -0
  229. {documenteer-1.2.1 → documenteer-1.2.2}/tests/data/package_beta/doc/README.md +0 -0
  230. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/__init__.py +0 -0
  231. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/autocppapi_test.py +0 -0
  232. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/lsstdocushare_test.py +0 -0
  233. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/lssttasks/__init__.py +0 -0
  234. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/lssttasks/taskutils_test.py +0 -0
  235. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/mockcoderefs_test.py +0 -0
  236. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/packagetoctree_test.py +0 -0
  237. {documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/utils_test.py +0 -0
  238. {documenteer-1.2.1 → documenteer-1.2.2}/tests/packagemetadata_test.py +0 -0
  239. {documenteer-1.2.1 → documenteer-1.2.2}/tests/roots/test-autocppapi/conf.py +0 -0
  240. {documenteer-1.2.1 → documenteer-1.2.2}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  241. {documenteer-1.2.1 → documenteer-1.2.2}/tests/roots/test-autocppapi/index.rst +0 -0
  242. {documenteer-1.2.1 → documenteer-1.2.2}/tests/services/__init__.py +0 -0
  243. {documenteer-1.2.1 → documenteer-1.2.2}/tests/services/technotemigration_test.py +0 -0
  244. {documenteer-1.2.1 → documenteer-1.2.2}/tests/storage/__init__.py +0 -0
  245. {documenteer-1.2.1 → documenteer-1.2.2}/tests/storage/authordb_test.py +0 -0
  246. {documenteer-1.2.1 → documenteer-1.2.2}/tests/storage/technotetoml_test.py +0 -0
  247. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_conf_utils.py +0 -0
  248. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_stackdocs_build.py +0 -0
  249. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_stackdocs_doxygen.py +0 -0
  250. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_stackdocs_doxygentag.py +0 -0
  251. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_stackdocs_pkgdiscovery.py +0 -0
  252. {documenteer-1.2.1 → documenteer-1.2.2}/tests/test_stackdocs_rootdiscovery.py +0 -0
  253. {documenteer-1.2.1 → documenteer-1.2.2}/tox.ini +0 -0
  254. {documenteer-1.2.1 → documenteer-1.2.2}/webpack.config.js +0 -0
{documenteer-1.2.1 → documenteer-1.2.2}/CHANGELOG.md RENAMED
@@ -2,6 +2,15 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-1.2.2'></a>
6
+ ## 1.2.2 (2024-04-11)
7
+
8
+ ### Bug fixes
9
+
10
+ - 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.
11
+ - Drop `jira.lsstcorp.org` from the linkcheck ignore list defaults for `documenteer.config.guide` since that instance is no longer being used.
12
+ - Replace `jira.lsstcorp.org` URLs in documentation to `rubinobs.atlassian.net`.
13
+
5
14
  <a id='changelog-1.2.1'></a>
6
15
  ## 1.2.1 (2024-04-02)
7
16
 
@@ -340,7 +349,7 @@ Fixes:
340
349
  - Individual Stack packages now import `documenteer.conf.pipelinespkg` in their `conf.py` files.
341
350
 
342
351
  The previous configuration sub-package, `documenteer.sphinxconf` is deprecated.
343
- [[DM-20866](https://jira.lsstcorp.org/browse/DM-20866)]
352
+ [[DM-20866](https://rubinobs.atlassian.net/browse/DM-20866)]
344
353
 
345
354
  Overall, the configurations are compatible with these exceptions:
346
355
 
@@ -363,13 +372,13 @@ Fixes:
363
372
  For example, individual packages can add to the `EXCLUDE` tag.
364
373
  By default, each package's `include` directory is included in the Doxygen build.
365
374
 
366
- [[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)]
375
+ [[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)]
367
376
 
368
377
  - Improved Sphinx runner (`documenteer.sphinxrunner`).
369
- [[DM-26768](https://jira.lsstcorp.org/browse/DM-26768)]
378
+ [[DM-26768](https://rubinobs.atlassian.net/browse/DM-26768)]
370
379
 
371
380
  - Added static type checking using [mypy](https://mypy.readthedocs.io/en/stable/).
372
- [[DM-22717](https://jira.lsstcorp.org/browse/DM-22717), [DM-26288](https://jira.lsstcorp.org/browse/DM-26288)]
381
+ [[DM-22717](https://rubinobs.atlassian.net/browse/DM-22717), [DM-26288](https://rubinobs.atlassian.net/browse/DM-26288)]
373
382
 
374
383
  - Improved packaging, testing, and development environment:
375
384
 
@@ -381,7 +390,7 @@ Fixes:
381
390
  - Migrated to `pre-commit` for running linters and code formatters.
382
391
  - Migrated to GitHub Actions from Travis CI.
383
392
 
384
- [`DM-22957 <https://jira.lsstcorp.org/browse/DM-22957>`_, `DM-26288 <https://jira.lsstcorp.org/browse/DM-26288>`_]
393
+ [`DM-22957 <https://rubinobs.atlassian.net/browse/DM-22957>`_, `DM-26288 <https://rubinobs.atlassian.net/browse/DM-26288>`_]
385
394
 
386
395
  - Documentation improvements:
387
396
 
@@ -396,19 +405,19 @@ Fixes:
396
405
 
397
406
  - Technote configuration now uses `yaml.safe_load` instead of `yaml.load`.
398
407
  See the [pyyaml docs for details](https://github.com/yaml/pyyaml/wiki/PyYAML-yaml.load(input)-Deprecation).
399
- [[DM-22537](https://jira.lsstcorp.org/browse/DM-22537)]
408
+ [[DM-22537](https://rubinobs.atlassian.net/browse/DM-22537)]
400
409
 
401
410
  ## 0.5.4 (2019-11-03)
402
411
 
403
412
  - This new version of the technote sphinx theme should fix the edition link in the sidebar for non-main editions.
404
- [[DM-20839](https://jira.lsstcorp.org/browse/DM-20839)]
413
+ [[DM-20839](https://rubinobs.atlassian.net/browse/DM-20839)]
405
414
 
406
415
  ## 0.5.3 (2019-08-07)
407
416
 
408
417
  - Enabled the `html_use_index` and `html_domain_indices` configurations for Stack documentation projects to enable automatic index generation.
409
418
  The `genindex` contains links to all command-line options and Python objects (Sphinx's domains).
410
419
  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).
411
- [[DM-20850](https://jira.lsstcorp.org/browse/DM-20850)]
420
+ [[DM-20850](https://rubinobs.atlassian.net/browse/DM-20850)]
412
421
 
413
422
  - Fixed compatibility with docutils 0.15.
414
423
  Now Sphinx will control which version of docutils is used, which should now be 0.15.
@@ -419,7 +428,7 @@ Fixes:
419
428
 
420
429
  - Add [sphinxcontrib.autoprogram](https://sphinxcontrib-autoprogram.readthedocs.io/en/stable/) to enable automated reference documentation of argparse-based command-line scripts.
421
430
  This extension is available with the `documenteer[pipelines]` installation extra and enabled by default for LSST Science Pipelines projects.
422
- [[DM-20767](https://jira.lsstcorp.org/browse/)]
431
+ [[DM-20767](https://rubinobs.atlassian.net/browse/)]
423
432
 
424
433
  - Update the official list of tested and supported Python versions to Python 3.6 and 3.7.
425
434
 
@@ -433,7 +442,7 @@ Fixes:
433
442
  - The stack documentation build now requires that packages be explicitly required by the main documentation project's EUPS table file.
434
443
  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.
435
444
  This would lead to packages being included in a documentation build despite not being a part of that stack product.
436
- [[DM-17765](https://jira.lsstcorp.org/browse/DM-17765)]
445
+ [[DM-17765](https://rubinobs.atlassian.net/browse/DM-17765)]
437
446
 
438
447
  - This release adds the [sphinx-jinja](https://github.com/tardyp/sphinx-jinja) extension for `documenteer[pipelines]` installations.
439
448
  This extension makes it possible to dynamically create content with Jinja templating.
@@ -453,7 +462,7 @@ Fixes:
453
462
  - `pipelines_demo_ref`
454
463
 
455
464
  These variables are accessible from the `jinja` directive's context.
456
- [[DM-17065](https://jira.lsstcorp.org/browse/DM-17065)]
465
+ [[DM-17065](https://rubinobs.atlassian.net/browse/DM-17065)]
457
466
 
458
467
  - This release also added some new substitutions to the `rst_epilog` of stack-based projects:
459
468
 
@@ -467,7 +476,7 @@ Fixes:
467
476
 
468
477
  - The project's name is also used as the `logotext` at the top of the page for stack-based projects.
469
478
  Previously the `logotext` would always be "LSST Science Pipelines."
470
- [[DM-17263](https://jira.lsstcorp.org/browse/DM-17263)]
479
+ [[DM-17263](https://rubinobs.atlassian.net/browse/DM-17263)]
471
480
 
472
481
  - Added the following projects to the intersphinx inventory of stack-based projects:
473
482
 
@@ -481,18 +490,18 @@ Fixes:
481
490
  ## 0.4.4 (2019-02-05)
482
491
 
483
492
  - Updated scikit-learn's intersphinx inventory URL (now available as HTTPS) in the `documenteer.sphinxconfig.stackconf`.
484
- - 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]]
493
+ - 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]]
485
494
 
486
495
  ## 0.4.3 (2018-11-30)
487
496
 
488
497
  - Pin [sphinxcontrib-bibtex](https://github.com/mcmtroffaes/sphinxcontrib-bibtex) to version 0.4.0 since later versions are incompatible with Sphinx <1.8.0.
489
- [[DM-16651](https://jira.lsstcorp.org/browse/DM-16651)]
498
+ [[DM-16651](https://rubinobs.atlassian.net/browse/DM-16651)]
490
499
 
491
500
  ## 0.4.2 (2018-11-01)
492
501
 
493
502
  - Handle cases where an object does not have a docstring in `documenteer.sphinxext.lssttasks.taskutils.get_docstring`.
494
503
  This improves the reliability of the `lsst-task-api-summary` directive.
495
- See (DM-16102)(https://jira.lsstcorp.org/browse/DM-16102).
504
+ See (DM-16102)(https://rubinobs.atlassian.net/browse/DM-16102).
496
505
 
497
506
  ## 0.4.1 (2018-10-15)
498
507
 
@@ -521,7 +530,7 @@ Fixes:
521
530
  This configuration is critical:
522
531
 
523
532
  1. It is actually responsible for ensuring that inherited members of classes appear in our docs.
524
- 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.
533
+ 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.
525
534
 
526
535
  - `todo` directives are now hidden when using `build_pipelines_lsst_io_configs`.
527
536
  They are still shown, by default, for standalone package documentation builds, which are primarily developer-facing.
@@ -650,7 +659,7 @@ Fixes:
650
659
 
651
660
  ## 0.1.10 (2016-12-14)
652
661
 
653
- Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://jira.lsstcorp.org/browse/DM-6199>`__:
662
+ Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://rubinobs.atlassian.net/browse/DM-6199>`__:
654
663
 
655
664
  - 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.
656
665
  - 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 +694,7 @@ Includes prototype support for LSST Science Pipelines documentation, as part of
685
694
 
686
695
  ## 0.1.3 (2016-05-24)
687
696
 
688
- - Add roles for linking to ls.st links: `lpm`, `ldm`, and `lse`. DM-6181.
697
+ - Add roles for linking to `ls.st` links: `lpm`, `ldm`, and `lse`. DM-6181.
689
698
  - Add roles for linking to JIRA tickets: `jira`, `jirab`, and `jirap`. DM-6181.
690
699
 
691
700
  ## 0.1.2 (2016-05-14)
{documenteer-1.2.1 → documenteer-1.2.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: documenteer
3
- Version: 1.2.1
3
+ Version: 1.2.2
4
4
  Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
5
  License: The MIT License (MIT)
6
6
 
{documenteer-1.2.1 → documenteer-1.2.2}/demo/ipynb-technote/index.ipynb RENAMED
@@ -21,7 +21,7 @@
21
21
  "\n",
22
22
  "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",
23
23
  "\n",
24
- "A parenthetical citation {cite:p}`2017arXiv170309824V`. And a textual citation {cite:t}`2017arXiv170309824V`."
24
+ "A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`."
25
25
  ]
26
26
  },
27
27
  {
{documenteer-1.2.1 → documenteer-1.2.2}/demo/md-technote/index.md RENAMED
@@ -10,7 +10,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetr
10
10
 
11
11
  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.
12
12
 
13
- A parenthetical citation {cite:p}`2017arXiv170309824V`. And a textual citation {cite:t}`2017arXiv170309824V`.
13
+ A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`.
14
14
 
15
15
  ## Method
16
16
 
{documenteer-1.2.1 → documenteer-1.2.2}/demo/rst-technote/index.rst RENAMED
@@ -16,7 +16,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetr
16
16
 
17
17
  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.
18
18
 
19
- A parenthetical citation :cite:p:`2017arXiv170309824V`. And a textual citation :cite:t:`2017arXiv170309824V`.
19
+ A parenthetical citation :cite:p:`SQR-083`. And a textual citation :cite:t:`SQR-083`.
20
20
 
21
21
  Method
22
22
  ======
{documenteer-1.2.1 → documenteer-1.2.2}/docs/changelog.md RENAMED
@@ -2,6 +2,15 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-1.2.2'></a>
6
+ ## 1.2.2 (2024-04-11)
7
+
8
+ ### Bug fixes
9
+
10
+ - 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.
11
+ - Drop `jira.lsstcorp.org` from the linkcheck ignore list defaults for `documenteer.config.guide` since that instance is no longer being used.
12
+ - Replace `jira.lsstcorp.org` URLs in documentation to `rubinobs.atlassian.net`.
13
+
5
14
  <a id='changelog-1.2.1'></a>
6
15
  ## 1.2.1 (2024-04-02)
7
16
 
@@ -340,7 +349,7 @@ Fixes:
340
349
  - Individual Stack packages now import `documenteer.conf.pipelinespkg` in their `conf.py` files.
341
350
 
342
351
  The previous configuration sub-package, `documenteer.sphinxconf` is deprecated.
343
- [[DM-20866](https://jira.lsstcorp.org/browse/DM-20866)]
352
+ [[DM-20866](https://rubinobs.atlassian.net/browse/DM-20866)]
344
353
 
345
354
  Overall, the configurations are compatible with these exceptions:
346
355
 
@@ -363,13 +372,13 @@ Fixes:
363
372
  For example, individual packages can add to the `EXCLUDE` tag.
364
373
  By default, each package's `include` directory is included in the Doxygen build.
365
374
 
366
- [[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)]
375
+ [[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)]
367
376
 
368
377
  - Improved Sphinx runner (`documenteer.sphinxrunner`).
369
- [[DM-26768](https://jira.lsstcorp.org/browse/DM-26768)]
378
+ [[DM-26768](https://rubinobs.atlassian.net/browse/DM-26768)]
370
379
 
371
380
  - Added static type checking using [mypy](https://mypy.readthedocs.io/en/stable/).
372
- [[DM-22717](https://jira.lsstcorp.org/browse/DM-22717), [DM-26288](https://jira.lsstcorp.org/browse/DM-26288)]
381
+ [[DM-22717](https://rubinobs.atlassian.net/browse/DM-22717), [DM-26288](https://rubinobs.atlassian.net/browse/DM-26288)]
373
382
 
374
383
  - Improved packaging, testing, and development environment:
375
384
 
@@ -381,7 +390,7 @@ Fixes:
381
390
  - Migrated to `pre-commit` for running linters and code formatters.
382
391
  - Migrated to GitHub Actions from Travis CI.
383
392
 
384
- [`DM-22957 <https://jira.lsstcorp.org/browse/DM-22957>`_, `DM-26288 <https://jira.lsstcorp.org/browse/DM-26288>`_]
393
+ [`DM-22957 <https://rubinobs.atlassian.net/browse/DM-22957>`_, `DM-26288 <https://rubinobs.atlassian.net/browse/DM-26288>`_]
385
394
 
386
395
  - Documentation improvements:
387
396
 
@@ -396,19 +405,19 @@ Fixes:
396
405
 
397
406
  - Technote configuration now uses `yaml.safe_load` instead of `yaml.load`.
398
407
  See the [pyyaml docs for details](https://github.com/yaml/pyyaml/wiki/PyYAML-yaml.load(input)-Deprecation).
399
- [[DM-22537](https://jira.lsstcorp.org/browse/DM-22537)]
408
+ [[DM-22537](https://rubinobs.atlassian.net/browse/DM-22537)]
400
409
 
401
410
  ## 0.5.4 (2019-11-03)
402
411
 
403
412
  - This new version of the technote sphinx theme should fix the edition link in the sidebar for non-main editions.
404
- [[DM-20839](https://jira.lsstcorp.org/browse/DM-20839)]
413
+ [[DM-20839](https://rubinobs.atlassian.net/browse/DM-20839)]
405
414
 
406
415
  ## 0.5.3 (2019-08-07)
407
416
 
408
417
  - Enabled the `html_use_index` and `html_domain_indices` configurations for Stack documentation projects to enable automatic index generation.
409
418
  The `genindex` contains links to all command-line options and Python objects (Sphinx's domains).
410
419
  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).
411
- [[DM-20850](https://jira.lsstcorp.org/browse/DM-20850)]
420
+ [[DM-20850](https://rubinobs.atlassian.net/browse/DM-20850)]
412
421
 
413
422
  - Fixed compatibility with docutils 0.15.
414
423
  Now Sphinx will control which version of docutils is used, which should now be 0.15.
@@ -419,7 +428,7 @@ Fixes:
419
428
 
420
429
  - Add [sphinxcontrib.autoprogram](https://sphinxcontrib-autoprogram.readthedocs.io/en/stable/) to enable automated reference documentation of argparse-based command-line scripts.
421
430
  This extension is available with the `documenteer[pipelines]` installation extra and enabled by default for LSST Science Pipelines projects.
422
- [[DM-20767](https://jira.lsstcorp.org/browse/)]
431
+ [[DM-20767](https://rubinobs.atlassian.net/browse/)]
423
432
 
424
433
  - Update the official list of tested and supported Python versions to Python 3.6 and 3.7.
425
434
 
@@ -433,7 +442,7 @@ Fixes:
433
442
  - The stack documentation build now requires that packages be explicitly required by the main documentation project's EUPS table file.
434
443
  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.
435
444
  This would lead to packages being included in a documentation build despite not being a part of that stack product.
436
- [[DM-17765](https://jira.lsstcorp.org/browse/DM-17765)]
445
+ [[DM-17765](https://rubinobs.atlassian.net/browse/DM-17765)]
437
446
 
438
447
  - This release adds the [sphinx-jinja](https://github.com/tardyp/sphinx-jinja) extension for `documenteer[pipelines]` installations.
439
448
  This extension makes it possible to dynamically create content with Jinja templating.
@@ -453,7 +462,7 @@ Fixes:
453
462
  - `pipelines_demo_ref`
454
463
 
455
464
  These variables are accessible from the `jinja` directive's context.
456
- [[DM-17065](https://jira.lsstcorp.org/browse/DM-17065)]
465
+ [[DM-17065](https://rubinobs.atlassian.net/browse/DM-17065)]
457
466
 
458
467
  - This release also added some new substitutions to the `rst_epilog` of stack-based projects:
459
468
 
@@ -467,7 +476,7 @@ Fixes:
467
476
 
468
477
  - The project's name is also used as the `logotext` at the top of the page for stack-based projects.
469
478
  Previously the `logotext` would always be "LSST Science Pipelines."
470
- [[DM-17263](https://jira.lsstcorp.org/browse/DM-17263)]
479
+ [[DM-17263](https://rubinobs.atlassian.net/browse/DM-17263)]
471
480
 
472
481
  - Added the following projects to the intersphinx inventory of stack-based projects:
473
482
 
@@ -481,18 +490,18 @@ Fixes:
481
490
  ## 0.4.4 (2019-02-05)
482
491
 
483
492
  - Updated scikit-learn's intersphinx inventory URL (now available as HTTPS) in the `documenteer.sphinxconfig.stackconf`.
484
- - 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]]
493
+ - 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]]
485
494
 
486
495
  ## 0.4.3 (2018-11-30)
487
496
 
488
497
  - Pin [sphinxcontrib-bibtex](https://github.com/mcmtroffaes/sphinxcontrib-bibtex) to version 0.4.0 since later versions are incompatible with Sphinx <1.8.0.
489
- [[DM-16651](https://jira.lsstcorp.org/browse/DM-16651)]
498
+ [[DM-16651](https://rubinobs.atlassian.net/browse/DM-16651)]
490
499
 
491
500
  ## 0.4.2 (2018-11-01)
492
501
 
493
502
  - Handle cases where an object does not have a docstring in `documenteer.sphinxext.lssttasks.taskutils.get_docstring`.
494
503
  This improves the reliability of the `lsst-task-api-summary` directive.
495
- See (DM-16102)(https://jira.lsstcorp.org/browse/DM-16102).
504
+ See (DM-16102)(https://rubinobs.atlassian.net/browse/DM-16102).
496
505
 
497
506
  ## 0.4.1 (2018-10-15)
498
507
 
@@ -521,7 +530,7 @@ Fixes:
521
530
  This configuration is critical:
522
531
 
523
532
  1. It is actually responsible for ensuring that inherited members of classes appear in our docs.
524
- 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.
533
+ 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.
525
534
 
526
535
  - `todo` directives are now hidden when using `build_pipelines_lsst_io_configs`.
527
536
  They are still shown, by default, for standalone package documentation builds, which are primarily developer-facing.
@@ -650,7 +659,7 @@ Fixes:
650
659
 
651
660
  ## 0.1.10 (2016-12-14)
652
661
 
653
- Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://jira.lsstcorp.org/browse/DM-6199>`__:
662
+ Includes prototype support for LSST Science Pipelines documentation, as part of `DM-6199 <https://rubinobs.atlassian.net/browse/DM-6199>`__:
654
663
 
655
664
  - 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.
656
665
  - 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 +694,7 @@ Includes prototype support for LSST Science Pipelines documentation, as part of
685
694
 
686
695
  ## 0.1.3 (2016-05-24)
687
696
 
688
- - Add roles for linking to ls.st links: `lpm`, `ldm`, and `lse`. DM-6181.
697
+ - Add roles for linking to `ls.st` links: `lpm`, `ldm`, and `lse`. DM-6181.
689
698
  - Add roles for linking to JIRA tickets: `jira`, `jirab`, and `jirap`. DM-6181.
690
699
 
691
700
  ## 0.1.2 (2016-05-14)
{documenteer-1.2.1 → documenteer-1.2.2}/docs/sphinx-extensions/jira-reference.rst RENAMED
@@ -4,7 +4,7 @@
4
4
  Jira reference roles
5
5
  ####################
6
6
 
7
- Documenteer provides reStructuredText roles to simplify linking to issues in LSST's Jira ticketing system at https://jira.lsstcorp.org.
7
+ Documenteer provides reStructuredText roles to simplify linking to issues in LSST's Jira ticketing system at https://rubinobs.atlassian.net.
8
8
 
9
9
  To use these roles, add the ``documenteer.ext.jira`` extension to your :file:`conf.py` file:
10
10
 
{documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/guide.py RENAMED
@@ -234,9 +234,8 @@ intersphinx_cache_limit = 5 # days
234
234
 
235
235
  linkcheck_retries = 2
236
236
 
237
- # Tucson IT infrastructure sometimes goes down or has TLS issues
238
237
  linkcheck_ignore = [
239
- r"^https://jira.lsstcorp.org/browse/",
238
+ # Tucson IT infrastructure sometimes goes down or has TLS issues
240
239
  r"^https://ls.st/",
241
240
  ]
242
241
  _conf.append_linkcheck_ignore(linkcheck_ignore)
{documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/conf/pipelines.py RENAMED
@@ -150,7 +150,7 @@ autoclass_content = "class"
150
150
  # methods.
151
151
  # NOTE: We want to used `inherited-members`, but it seems to be causing
152
152
  # documentation duplication in the automodapi listings. We're leaving
153
- # this out for now. See https://jira.lsstcorp.org/browse/DM-14782 for
153
+ # this out for now. See https://rubinobs.atlassian.net/browse/DM-14782 for
154
154
  # additional notes.
155
155
  # NOTE: Without inherited members set, special-members doesn't need seem
156
156
  # to have an effect (even for special members where the docstrings are
{documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer/ext/jira.py RENAMED
@@ -153,7 +153,7 @@ def jira_parens_role(
153
153
  def setup(app):
154
154
  app.add_config_value(
155
155
  "jira_uri_template",
156
- default="https://jira.lsstcorp.org/browse/{ticket}",
156
+ default="https://rubinobs.atlassian.net/browse/{ticket}",
157
157
  rebuild="html",
158
158
  )
159
159
  app.add_role("jira", jira_role)
{documenteer-1.2.1 → documenteer-1.2.2}/src/documenteer.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: documenteer
3
- Version: 1.2.1
3
+ Version: 1.2.2
4
4
  Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
5
  License: The MIT License (MIT)
6
6
 
{documenteer-1.2.1 → documenteer-1.2.2}/tests/ext/jira_test.py RENAMED
@@ -18,7 +18,7 @@ except ImportError:
18
18
  from mock import Mock
19
19
 
20
20
 
21
- URI = "https://jira.lsstcorp.org/browse/{ticket}"
21
+ URI = "https://rubinobs.atlassian.net/browse/{ticket}"
22
22
 
23
23
 
24
24
  @pytest.fixture()
{documenteer-1.2.1 → documenteer-1.2.2}/tests/test_conf_toml.py RENAMED
@@ -139,12 +139,12 @@ def test_append_linkcheck_ignore() -> None:
139
139
  config = DocumenteerConfig.load(EXAMPLE)
140
140
 
141
141
  linkcheck_ignore = [
142
- r"^https://jira.lsstcorp.org/browse/",
142
+ r"^https://rubinobs.atlassian.net/browse/",
143
143
  r"^https://ls.st/",
144
144
  ]
145
145
  config.append_linkcheck_ignore(linkcheck_ignore)
146
146
  assert linkcheck_ignore == [
147
- r"^https://jira.lsstcorp.org/browse/",
147
+ r"^https://rubinobs.atlassian.net/browse/",
148
148
  r"^https://ls.st/",
149
149
  r"^https://confluence.lsstcorp.org/",
150
150
  ]
{documenteer-1.2.1 → documenteer-1.2.2}/.flake8 RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/.gitignore RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/.npmrc RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/.nvmrc RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/.prettierignore RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/LICENSE RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/MANIFEST.in RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/Makefile RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/README.md RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/docs/.gitignore RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/docs/Makefile RENAMED
File without changes
{documenteer-1.2.1 → documenteer-1.2.2}/docs/conf.py RENAMED
File without changes