documenteer 1.4.2__tar.gz → 1.4.5__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 (259) hide show
  1. {documenteer-1.4.2 → documenteer-1.4.5}/.github/SUPPORT.md +1 -1
  2. {documenteer-1.4.2 → documenteer-1.4.5}/.github/workflows/ci-cron.yaml +1 -2
  3. {documenteer-1.4.2 → documenteer-1.4.5}/.github/workflows/ci.yaml +28 -9
  4. {documenteer-1.4.2 → documenteer-1.4.5}/.pre-commit-config.yaml +0 -6
  5. {documenteer-1.4.2 → documenteer-1.4.5}/.prettierignore +2 -0
  6. {documenteer-1.4.2 → documenteer-1.4.5}/CHANGELOG.md +31 -2
  7. {documenteer-1.4.2 → documenteer-1.4.5}/PKG-INFO +8 -29
  8. {documenteer-1.4.2 → documenteer-1.4.5}/docs/_rst_epilog.rst +1 -1
  9. {documenteer-1.4.2 → documenteer-1.4.5}/docs/changelog.md +31 -2
  10. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/migrate.rst +4 -4
  11. {documenteer-1.4.2 → documenteer-1.4.5}/package-lock.json +22 -0
  12. {documenteer-1.4.2 → documenteer-1.4.5}/package.json +1 -0
  13. {documenteer-1.4.2 → documenteer-1.4.5}/pyproject.toml +6 -6
  14. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/_properties.scss +3 -3
  15. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-pydata-theme.css +2 -2
  16. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-technote.css +3 -3
  17. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-technote.css.map +1 -1
  18. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/cli.py +2 -2
  19. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/guide.py +1 -1
  20. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/PKG-INFO +8 -29
  21. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/requires.txt +4 -4
  22. {documenteer-1.4.2 → documenteer-1.4.5}/tox.ini +7 -1
  23. {documenteer-1.4.2 → documenteer-1.4.5}/.flake8 +0 -0
  24. {documenteer-1.4.2 → documenteer-1.4.5}/.github/CODE_OF_CONDUCT.md +0 -0
  25. {documenteer-1.4.2 → documenteer-1.4.5}/.github/CONTRIBUTING.md +0 -0
  26. {documenteer-1.4.2 → documenteer-1.4.5}/.github/dependabot.yml +0 -0
  27. {documenteer-1.4.2 → documenteer-1.4.5}/.github/workflows/dependencies.yaml +0 -0
  28. {documenteer-1.4.2 → documenteer-1.4.5}/.gitignore +0 -0
  29. {documenteer-1.4.2 → documenteer-1.4.5}/.npmrc +0 -0
  30. {documenteer-1.4.2 → documenteer-1.4.5}/.nvmrc +0 -0
  31. {documenteer-1.4.2 → documenteer-1.4.5}/.prettierrc.yaml +0 -0
  32. {documenteer-1.4.2 → documenteer-1.4.5}/.vscode/settings.json +0 -0
  33. {documenteer-1.4.2 → documenteer-1.4.5}/.vscode/tasks.json +0 -0
  34. {documenteer-1.4.2 → documenteer-1.4.5}/LICENSE +0 -0
  35. {documenteer-1.4.2 → documenteer-1.4.5}/MANIFEST.in +0 -0
  36. {documenteer-1.4.2 → documenteer-1.4.5}/Makefile +0 -0
  37. {documenteer-1.4.2 → documenteer-1.4.5}/README.md +0 -0
  38. {documenteer-1.4.2 → documenteer-1.4.5}/changelog.d/_template.md.jinja +0 -0
  39. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/.gitignore +0 -0
  40. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/Makefile +0 -0
  41. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/conf.py +0 -0
  42. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/diagram.py +0 -0
  43. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
  44. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/index.ipynb +0 -0
  45. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
  46. {documenteer-1.4.2 → documenteer-1.4.5}/demo/ipynb-technote/technote.toml +0 -0
  47. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/.gitignore +0 -0
  48. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/Makefile +0 -0
  49. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/conf.py +0 -0
  50. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/diagram.py +0 -0
  51. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/index.md +0 -0
  52. {documenteer-1.4.2 → documenteer-1.4.5}/demo/md-technote/technote.toml +0 -0
  53. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/.gitignore +0 -0
  54. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/Makefile +0 -0
  55. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/conf.py +0 -0
  56. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/diagram.py +0 -0
  57. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/index.rst +0 -0
  58. {documenteer-1.4.2 → documenteer-1.4.5}/demo/rst-technote/technote.toml +0 -0
  59. {documenteer-1.4.2 → documenteer-1.4.5}/docs/.gitignore +0 -0
  60. {documenteer-1.4.2 → documenteer-1.4.5}/docs/Makefile +0 -0
  61. {documenteer-1.4.2 → documenteer-1.4.5}/docs/conf.py +0 -0
  62. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/documenteer.conf.rst +0 -0
  63. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/documenteer.ext.rst +0 -0
  64. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/documenteer.requestsutils.rst +0 -0
  65. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/documenteer.sphinxrunner.rst +0 -0
  66. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/documenteer.stackdocs.rst +0 -0
  67. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/api/index.rst +0 -0
  68. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/development.rst +0 -0
  69. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/html-templates.rst +0 -0
  70. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/index.rst +0 -0
  71. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/release.rst +0 -0
  72. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/theme-assets.rst +0 -0
  73. {documenteer-1.4.2 → documenteer-1.4.5}/docs/dev/theme.rst +0 -0
  74. {documenteer-1.4.2 → documenteer-1.4.5}/docs/documenteer.toml +0 -0
  75. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/badges.rst +0 -0
  76. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/configuration-preset.rst +0 -0
  77. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/configuration.rst +0 -0
  78. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/diagrams.rst +0 -0
  79. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/extend-conf-py.rst +0 -0
  80. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/including-notebooks.ipynb +0 -0
  81. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/index.rst +0 -0
  82. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/markdown-primer.md +0 -0
  83. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/openapi.rst +0 -0
  84. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/organization.rst +0 -0
  85. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/overview.rst +0 -0
  86. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/page-redirects.rst +0 -0
  87. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/build-overview.rst +0 -0
  88. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/configuration.rst +0 -0
  89. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/cpp-api-linking.rst +0 -0
  90. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/index.rst +0 -0
  91. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/install.rst +0 -0
  92. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/package-docs-cli.rst +0 -0
  93. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pipelines/stack-docs-cli.rst +0 -0
  94. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/pyproject-configuration.rst +0 -0
  95. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/rst-epilog.rst +0 -0
  96. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/tabsets.rst +0 -0
  97. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/toml-reference.rst +0 -0
  98. {documenteer-1.4.2 → documenteer-1.4.5}/docs/guides/video-embeds.rst +0 -0
  99. {documenteer-1.4.2 → documenteer-1.4.5}/docs/index.rst +0 -0
  100. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/autocppapi.rst +0 -0
  101. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/autodocreset.rst +0 -0
  102. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  103. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  104. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/index.rst +0 -0
  105. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/jira-reference.rst +0 -0
  106. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  107. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/lssttasks.rst +0 -0
  108. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/openapi.rst +0 -0
  109. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/package-toctree.rst +0 -0
  110. {documenteer-1.4.2 → documenteer-1.4.5}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  111. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/_templates/README.md +0 -0
  112. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/_templates/README.rst +0 -0
  113. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/author-metadata.rst +0 -0
  114. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/configuration.rst +0 -0
  115. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/document-status.rst +0 -0
  116. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/edit-locally.rst +0 -0
  117. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/edit-on-github.rst +0 -0
  118. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/extensions.rst +0 -0
  119. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  120. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/index.rst +0 -0
  121. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/start-a-technote.rst +0 -0
  122. {documenteer-1.4.2 → documenteer-1.4.5}/docs/technotes/wide-content.rst +0 -0
  123. {documenteer-1.4.2 → documenteer-1.4.5}/licenses/README.md +0 -0
  124. {documenteer-1.4.2 → documenteer-1.4.5}/licenses/astropy-helpers.txt +0 -0
  125. {documenteer-1.4.2 → documenteer-1.4.5}/licenses/sphinx-issue.txt +0 -0
  126. {documenteer-1.4.2 → documenteer-1.4.5}/licenses/sphinx.txt +0 -0
  127. {documenteer-1.4.2 → documenteer-1.4.5}/postcss.config.js +0 -0
  128. {documenteer-1.4.2 → documenteer-1.4.5}/setup.cfg +0 -0
  129. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  130. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  131. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  132. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  133. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  134. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  135. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  136. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  137. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  138. {documenteer-1.4.2 → documenteer-1.4.5}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  139. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/__init__.py +0 -0
  140. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/.gitignore +0 -0
  141. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  142. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  143. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/favicon.ico +0 -0
  144. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  145. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  146. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  147. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-favicon.svg +0 -0
  148. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  149. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  150. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  151. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  152. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/__init__.py +0 -0
  153. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/_toml.py +0 -0
  154. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/_utils.py +0 -0
  155. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/pipelines.py +0 -0
  156. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/pipelinespkg.py +0 -0
  157. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/conf/technote.py +0 -0
  158. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/__init__.py +0 -0
  159. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/_utils.py +0 -0
  160. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/autocppapi.py +0 -0
  161. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/autodocreset.py +0 -0
  162. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/bibtex.py +0 -0
  163. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/githubbibcache.py +0 -0
  164. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/jira.py +0 -0
  165. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lsstdocushare.py +0 -0
  166. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/__init__.py +0 -0
  167. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/configfieldlists.py +0 -0
  168. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/crossrefs.py +0 -0
  169. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/pyapisummary.py +0 -0
  170. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/taskutils.py +0 -0
  171. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/topiclists.py +0 -0
  172. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/lssttasks/topics.py +0 -0
  173. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/mockcoderefs.py +0 -0
  174. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/openapi.py +0 -0
  175. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/packagetoctree.py +0 -0
  176. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/ext/remotecodeblock.py +0 -0
  177. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/packagemetadata.py +0 -0
  178. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/py.typed +0 -0
  179. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/requestsutils.py +0 -0
  180. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/services/__init__.py +0 -0
  181. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/services/technoteauthor.py +0 -0
  182. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/services/technotemigration.py +0 -0
  183. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/sphinxrunner.py +0 -0
  184. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/__init__.py +0 -0
  185. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/build.py +0 -0
  186. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -0
  187. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -0
  188. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/data/mainpage.dox +0 -0
  189. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/doxygen.py +0 -0
  190. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/doxygentag.py +0 -0
  191. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/packagecli.py +0 -0
  192. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/pkgdiscovery.py +0 -0
  193. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/rootdiscovery.py +0 -0
  194. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/stackdocs/stackcli.py +0 -0
  195. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/__init__.py +0 -0
  196. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/authordb.py +0 -0
  197. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/latex.py +0 -0
  198. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  199. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  200. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  201. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
  202. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  203. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  204. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  205. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  206. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  207. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/localtemplates.py +0 -0
  208. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/storage/technotetoml.py +0 -0
  209. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/pydata/layout.html +0 -0
  210. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/.gitkeep +0 -0
  211. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  212. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  213. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  214. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  215. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  216. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/utils.py +0 -0
  217. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer/version.py +0 -0
  218. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/SOURCES.txt +0 -0
  219. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/dependency_links.txt +0 -0
  220. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/entry_points.txt +0 -0
  221. {documenteer-1.4.2 → documenteer-1.4.5}/src/documenteer.egg-info/top_level.txt +0 -0
  222. {documenteer-1.4.2 → documenteer-1.4.5}/tests/conftest.py +0 -0
  223. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/afw.doxygen.conf +0 -0
  224. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/authordb.yaml +0 -0
  225. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/doxygen.tag.zip +0 -0
  226. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  227. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  228. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  229. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  230. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  231. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/include/README.md +0 -0
  232. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_alpha/src/README.md +0 -0
  233. {documenteer-1.4.2 → documenteer-1.4.5}/tests/data/package_beta/doc/README.md +0 -0
  234. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/__init__.py +0 -0
  235. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/autocppapi_test.py +0 -0
  236. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/jira_test.py +0 -0
  237. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/lsstdocushare_test.py +0 -0
  238. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/lssttasks/__init__.py +0 -0
  239. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/lssttasks/taskutils_test.py +0 -0
  240. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/mockcoderefs_test.py +0 -0
  241. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/packagetoctree_test.py +0 -0
  242. {documenteer-1.4.2 → documenteer-1.4.5}/tests/ext/utils_test.py +0 -0
  243. {documenteer-1.4.2 → documenteer-1.4.5}/tests/packagemetadata_test.py +0 -0
  244. {documenteer-1.4.2 → documenteer-1.4.5}/tests/roots/test-autocppapi/conf.py +0 -0
  245. {documenteer-1.4.2 → documenteer-1.4.5}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  246. {documenteer-1.4.2 → documenteer-1.4.5}/tests/roots/test-autocppapi/index.rst +0 -0
  247. {documenteer-1.4.2 → documenteer-1.4.5}/tests/services/__init__.py +0 -0
  248. {documenteer-1.4.2 → documenteer-1.4.5}/tests/services/technotemigration_test.py +0 -0
  249. {documenteer-1.4.2 → documenteer-1.4.5}/tests/storage/__init__.py +0 -0
  250. {documenteer-1.4.2 → documenteer-1.4.5}/tests/storage/authordb_test.py +0 -0
  251. {documenteer-1.4.2 → documenteer-1.4.5}/tests/storage/technotetoml_test.py +0 -0
  252. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_conf_toml.py +0 -0
  253. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_conf_utils.py +0 -0
  254. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_stackdocs_build.py +0 -0
  255. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_stackdocs_doxygen.py +0 -0
  256. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_stackdocs_doxygentag.py +0 -0
  257. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_stackdocs_pkgdiscovery.py +0 -0
  258. {documenteer-1.4.2 → documenteer-1.4.5}/tests/test_stackdocs_rootdiscovery.py +0 -0
  259. {documenteer-1.4.2 → documenteer-1.4.5}/webpack.config.js +0 -0
@@ -1,5 +1,5 @@
1
1
  Here are some ways to get help with Documenteer:
2
2
 
3
3
  - [Documentation](https://documenteer.lsst.io)
4
- - [Ask a question in #dm-docs-support (for Rubin staff)](https://lsstc.slack.com/archives/C2B6DQBAL)
4
+ - [Ask a question in #square-docs-support (for Rubin staff)](https://rubin-obs.slack.com/archives/C07QK9N14BY)
5
5
  - [Post a GitHub issue](https://github.com/lsst-sqre/documenteer/issues/new)
@@ -92,7 +92,6 @@ jobs:
92
92
  npm run build
93
93
 
94
94
  - name: Build and publish
95
- uses: lsst-sqre/build-and-publish-to-pypi@v2
95
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
96
96
  with:
97
- python-version: "3.12"
98
97
  upload: false
@@ -26,8 +26,27 @@ jobs:
26
26
  with:
27
27
  python-version: '3.12'
28
28
 
29
- - name: Run pre-commit
30
- uses: pre-commit/action@v3.0.1
29
+ - uses: actions/setup-node@v4
30
+ with:
31
+ cache: 'npm'
32
+ node-version-file: '.nvmrc'
33
+
34
+ - name: Authenticate GitHub Packages
35
+ run: |
36
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
37
+ env:
38
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39
+
40
+ - name: npm install and build
41
+ run: |
42
+ npm install
43
+ npm run build
44
+
45
+ - name: Run tox
46
+ uses: lsst-sqre/run-tox@v1
47
+ with:
48
+ python-version: '3.12'
49
+ tox-envs: 'lint'
31
50
 
32
51
  test:
33
52
  runs-on: ubuntu-latest
@@ -37,8 +56,10 @@ jobs:
37
56
  python-version:
38
57
  - '3.11'
39
58
  - '3.12'
59
+ - '3.13'
40
60
  sphinx-version:
41
61
  - '7'
62
+ - '8'
42
63
 
43
64
  steps:
44
65
  - uses: actions/checkout@v4
@@ -70,7 +91,7 @@ jobs:
70
91
  uses: lsst-sqre/run-tox@v1
71
92
  with:
72
93
  python-version: ${{ matrix.python-version }}
73
- tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
94
+ tox-envs: 'lint,py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
74
95
 
75
96
  docs:
76
97
  runs-on: ubuntu-latest
@@ -103,6 +124,7 @@ jobs:
103
124
  if: >
104
125
  github.event_name != 'pull_request' || startsWith(github.head_ref, 'tickets/')
105
126
 
127
+
106
128
  test-package:
107
129
  name: Test PyPI package build
108
130
  runs-on: ubuntu-latest
@@ -113,10 +135,9 @@ jobs:
113
135
  fetch-depth: 0 # full history for setuptools_scm
114
136
 
115
137
  - name: Build and publish
116
- uses: lsst-sqre/build-and-publish-to-pypi@v2
138
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
117
139
  with:
118
- python-version: "3.12"
119
- upload: "false"
140
+ upload: 'false'
120
141
 
121
142
  pypi-publish:
122
143
  name: Upload release to PyPI
@@ -145,6 +166,4 @@ jobs:
145
166
  npm run build
146
167
 
147
168
  - name: Build and publish
148
- uses: lsst-sqre/build-and-publish-to-pypi@v2
149
- with:
150
- python-version: '3.12'
169
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
@@ -37,9 +37,3 @@ repos:
37
37
  rev: 7.0.0
38
38
  hooks:
39
39
  - id: flake8
40
-
41
- - repo: https://github.com/pre-commit/mirrors-prettier
42
- rev: v4.0.0-alpha.8
43
- hooks:
44
- - id: prettier
45
- types_or: [css, scss, javascript]
@@ -2,6 +2,8 @@ demo/
2
2
  .tox
3
3
  *.md
4
4
  **/*.md
5
+ **/*.yml
6
+ **/*.yaml
5
7
  src/documenteer/templates/**/*.html
6
8
  src/documenteer/assets/static/styles
7
9
  src/documenteer/assets/static/scripts
@@ -2,19 +2,48 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-1.4.5'></a>
6
+ ## 1.4.5 (2025-06-25)
7
+
8
+ ### Other changes
9
+
10
+ - Update to lsst-sqre/build-and-publish-to-pypi@v3 for publishing to PyPI.
11
+
12
+ <a id='changelog-1.4.4'></a>
13
+ ## 1.4.4 (2025-06-25)
14
+
15
+ ### Bug fixes
16
+
17
+ - Fix the configuration of the `sphinx-prompt` extension to be `sphinx_prompt` in the `documenteer.conf.guide` configuration. Constrain the sphinx-prompt version to be `>1.10.0,<2.0.0` to avoid issues with the `sphinx_prompt` extension not being recognized.
18
+
19
+ ### Other changes
20
+
21
+ - Add testing against Python 3.13 and Sphinx 8.
22
+
23
+ <a id='changelog-1.4.3'></a>
24
+ ## 1.4.3 (2025-02-19)
25
+
26
+ ### Bug fixes
27
+
28
+ - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
29
+
30
+ ### Other changes
31
+
32
+ - Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
33
+
5
34
  <a id='changelog-1.4.2'></a>
6
35
  ## 1.4.2 (2024-10-15)
7
36
 
8
37
  ### Bug fixes
9
38
 
10
- - Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
39
+ - Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
11
40
 
12
41
  <a id='changelog-1.4.1'></a>
13
42
  ## 1.4.1 (2024-10-10)
14
43
 
15
44
  ### Bug fixes
16
45
 
17
- - Pin `sphinx` to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
46
+ - Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
18
47
 
19
48
  <a id='changelog-1.4.0'></a>
20
49
  ## 1.4.0 (2024-07-11)
@@ -1,34 +1,12 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: documenteer
3
- Version: 1.4.2
3
+ Version: 1.4.5
4
4
  Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
- License: The MIT License (MIT)
6
-
7
- Copyright (c) 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA)
8
-
9
- Permission is hereby granted, free of charge, to any person obtaining a copy
10
- of this software and associated documentation files (the "Software"), to deal
11
- in the Software without restriction, including without limitation the rights
12
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
- copies of the Software, and to permit persons to whom the Software is
14
- furnished to do so, subject to the following conditions:
15
-
16
- The above copyright notice and this permission notice shall be included in all
17
- copies or substantial portions of the Software.
18
-
19
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
- SOFTWARE.
26
-
5
+ License-Expression: MIT
27
6
  Project-URL: Homepage, https://documenteer.lsst.io
28
7
  Project-URL: Source, https://github.com/lsst-sqre/documenteer
29
8
  Keywords: rubin,lsst
30
9
  Classifier: Development Status :: 4 - Beta
31
- Classifier: License :: OSI Approved :: MIT License
32
10
  Classifier: Programming Language :: Python
33
11
  Classifier: Programming Language :: Python :: 3
34
12
  Classifier: Programming Language :: Python :: 3.11
@@ -43,7 +21,7 @@ Requires-Python: >=3.11
43
21
  Description-Content-Type: text/markdown
44
22
  License-File: LICENSE
45
23
  Requires-Dist: docutils>=0.20
46
- Requires-Dist: Sphinx>=7
24
+ Requires-Dist: Sphinx<8.2,>=7
47
25
  Requires-Dist: PyYAML
48
26
  Requires-Dist: GitPython
49
27
  Requires-Dist: requests
@@ -75,7 +53,7 @@ Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
75
53
  Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
76
54
  Requires-Dist: sphinx-automodapi; extra == "guide"
77
55
  Requires-Dist: sphinx-copybutton; extra == "guide"
78
- Requires-Dist: sphinx-prompt; extra == "guide"
56
+ Requires-Dist: sphinx-prompt<2,>=1.10.0; extra == "guide"
79
57
  Requires-Dist: sphinx-jinja>=2; extra == "guide"
80
58
  Requires-Dist: myst-parser; extra == "guide"
81
59
  Requires-Dist: myst-nb; extra == "guide"
@@ -92,7 +70,7 @@ Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
92
70
  Requires-Dist: sphinx-autodoc-typehints; extra == "pipelines"
93
71
  Requires-Dist: sphinx-automodapi; extra == "pipelines"
94
72
  Requires-Dist: sphinx-copybutton; extra == "pipelines"
95
- Requires-Dist: sphinx-prompt; extra == "pipelines"
73
+ Requires-Dist: sphinx-prompt<2,>=1.10.0; extra == "pipelines"
96
74
  Requires-Dist: sphinx-jinja>=2; extra == "pipelines"
97
75
  Requires-Dist: myst-parser; extra == "pipelines"
98
76
  Requires-Dist: markdown-it-py[linkify]; extra == "pipelines"
@@ -105,12 +83,13 @@ Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
105
83
  Requires-Dist: sphinx-click; extra == "pipelines"
106
84
  Provides-Extra: technote
107
85
  Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
108
- Requires-Dist: sphinx-prompt; extra == "technote"
86
+ Requires-Dist: sphinx-prompt<2,>=1.10.0; extra == "technote"
109
87
  Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
110
88
  Requires-Dist: sphinx-diagrams; extra == "technote"
111
89
  Requires-Dist: sphinx_design; extra == "technote"
112
90
  Requires-Dist: myst-nb; extra == "technote"
113
91
  Requires-Dist: sphinxcontrib-youtube; extra == "technote"
92
+ Dynamic: license-file
114
93
 
115
94
  [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
116
95
  [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
@@ -13,7 +13,7 @@
13
13
  .. _sphinxcontrib-mermaid: https://github.com/mgaitan/sphinxcontrib-mermaid
14
14
  .. _Diagrams: https://diagrams.mingrammer.com/
15
15
  .. _sphinx-diagrams: https://github.com/j-martin/sphinx-diagrams
16
- .. _`#dm-docs-support`: https://lsstc.slack.com/archives/C2B6DQBAL
16
+ .. _`#square-docs-support`: https://rubin-obs.slack.com/archives/C07QK9N14BY
17
17
  .. _`DMTN-030`:
18
18
  .. _`DMTN-030 Science Pipelines Documentation Design`: https://dmtn-030.lsst.io
19
19
  .. _`Google Developer Style Guide`: https://developers.google.com/style/
@@ -2,19 +2,48 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-1.4.5'></a>
6
+ ## 1.4.5 (2025-06-25)
7
+
8
+ ### Other changes
9
+
10
+ - Update to lsst-sqre/build-and-publish-to-pypi@v3 for publishing to PyPI.
11
+
12
+ <a id='changelog-1.4.4'></a>
13
+ ## 1.4.4 (2025-06-25)
14
+
15
+ ### Bug fixes
16
+
17
+ - Fix the configuration of the `sphinx-prompt` extension to be `sphinx_prompt` in the `documenteer.conf.guide` configuration. Constrain the sphinx-prompt version to be `>1.10.0,<2.0.0` to avoid issues with the `sphinx_prompt` extension not being recognized.
18
+
19
+ ### Other changes
20
+
21
+ - Add testing against Python 3.13 and Sphinx 8.
22
+
23
+ <a id='changelog-1.4.3'></a>
24
+ ## 1.4.3 (2025-02-19)
25
+
26
+ ### Bug fixes
27
+
28
+ - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
29
+
30
+ ### Other changes
31
+
32
+ - Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
33
+
5
34
  <a id='changelog-1.4.2'></a>
6
35
  ## 1.4.2 (2024-10-15)
7
36
 
8
37
  ### Bug fixes
9
38
 
10
- - Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
39
+ - Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
11
40
 
12
41
  <a id='changelog-1.4.1'></a>
13
42
  ## 1.4.1 (2024-10-10)
14
43
 
15
44
  ### Bug fixes
16
45
 
17
- - Pin `sphinx` to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
46
+ - Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
18
47
 
19
48
  <a id='changelog-1.4.0'></a>
20
49
  ## 1.4.0 (2024-07-11)
@@ -134,7 +134,7 @@ You might also want to run the linter to check links and find common issues:
134
134
  make lint
135
135
 
136
136
  If you have any questions or issues about the build, you should still proceed with committing and creating a pull request (see next step).
137
- This way you can link to the repository when you reach out for help in `#dm-docs-support`_ on Slack.
137
+ This way you can link to the repository when you reach out for help in `#square-docs-support`_ on Slack.
138
138
 
139
139
  Step 7. Commit the migration, pull request, and merge
140
140
  =====================================================
@@ -145,7 +145,7 @@ GitHub Actions will build the technote and publish a preview version that is lin
145
145
 
146
146
  If the build works, you can merge the pull request.
147
147
 
148
- If there are build errors, you can reach out to `#dm-docs-support`_ on Slack for help.
148
+ If there are build errors, you can reach out to `#square-docs-support`_ on Slack for help.
149
149
  Include the repository URL and ideally a link to the pull request or GitHub Actions workflow run that failed.
150
150
 
151
151
  .. _technote-migration-detailed:
@@ -214,7 +214,7 @@ For most technotes, the :file:`conf.py` file should be a single line:
214
214
  from documenteer.conf.technote import * # noqa: F401, F403
215
215
 
216
216
  If your :file:`conf.py` file has additional content, some of that configuration may be migrated to :file:`technote.toml`.
217
- Reach out to `#dm-docs-support`_ on Slack for advice.
217
+ Reach out to `#square-docs-support`_ on Slack for advice.
218
218
 
219
219
  index.rst file (updated)
220
220
  ------------------------
@@ -416,7 +416,7 @@ The Python dependencies for your technote are listed in a :file:`requirements.tx
416
416
 
417
417
  .. note::
418
418
 
419
- If your technote has additional dependencies listed, you can reach out to `#dm-docs-support`_ on Slack if you are unsure whether they are part of the Sphinx build process or separate packages needed for any custom document preprocessing.
419
+ If your technote has additional dependencies listed, you can reach out to `#square-docs-support`_ on Slack if you are unsure whether they are part of the Sphinx build process or separate packages needed for any custom document preprocessing.
420
420
 
421
421
  tox.ini file (added)
422
422
  --------------------
@@ -15,6 +15,7 @@
15
15
  "mini-css-extract-plugin": "^2.4.4",
16
16
  "normalize.css": "^8.0.1",
17
17
  "postcss-loader": "^6.2.0",
18
+ "prettier": "3.5.1",
18
19
  "sass": "^1.53.0",
19
20
  "sass-loader": "^12.3.0",
20
21
  "style-loader": "^3.3.1",
@@ -2470,6 +2471,21 @@
2470
2471
  "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
2471
2472
  "dev": true
2472
2473
  },
2474
+ "node_modules/prettier": {
2475
+ "version": "3.5.1",
2476
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.1.tgz",
2477
+ "integrity": "sha512-hPpFQvHwL3Qv5AdRvBFMhnKo4tYxp0ReXiPn2bxkiohEX6mBeBwEpBSQTkD458RaaDKQMYSp4hX4UtfUTA5wDw==",
2478
+ "dev": true,
2479
+ "bin": {
2480
+ "prettier": "bin/prettier.cjs"
2481
+ },
2482
+ "engines": {
2483
+ "node": ">=14"
2484
+ },
2485
+ "funding": {
2486
+ "url": "https://github.com/prettier/prettier?sponsor=1"
2487
+ }
2488
+ },
2473
2489
  "node_modules/punycode": {
2474
2490
  "version": "2.1.1",
2475
2491
  "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
@@ -5030,6 +5046,12 @@
5030
5046
  "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
5031
5047
  "dev": true
5032
5048
  },
5049
+ "prettier": {
5050
+ "version": "3.5.1",
5051
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.1.tgz",
5052
+ "integrity": "sha512-hPpFQvHwL3Qv5AdRvBFMhnKo4tYxp0ReXiPn2bxkiohEX6mBeBwEpBSQTkD458RaaDKQMYSp4hX4UtfUTA5wDw==",
5053
+ "dev": true
5054
+ },
5033
5055
  "punycode": {
5034
5056
  "version": "2.1.1",
5035
5057
  "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
@@ -11,6 +11,7 @@
11
11
  "mini-css-extract-plugin": "^2.4.4",
12
12
  "normalize.css": "^8.0.1",
13
13
  "postcss-loader": "^6.2.0",
14
+ "prettier": "3.5.1",
14
15
  "sass": "^1.53.0",
15
16
  "sass-loader": "^12.3.0",
16
17
  "style-loader": "^3.3.1",
@@ -2,13 +2,13 @@
2
2
  # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
3
3
  name = "documenteer"
4
4
  description = "Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations."
5
- license = { file = "LICENSE" }
5
+ license = "MIT"
6
+ license-files = ["LICENSE"]
6
7
  readme = "README.md"
7
8
  keywords = ["rubin", "lsst"]
8
9
  # https://pypi.org/classifiers/
9
10
  classifiers = [
10
11
  "Development Status :: 4 - Beta",
11
- "License :: OSI Approved :: MIT License",
12
12
  "Programming Language :: Python",
13
13
  "Programming Language :: Python :: 3",
14
14
  "Programming Language :: Python :: 3.11",
@@ -24,7 +24,7 @@ requires-python = ">=3.11"
24
24
  dynamic = ["version"]
25
25
  dependencies = [
26
26
  "docutils>=0.20", # solves an extra div bug with the bibliography directive
27
- "Sphinx>=7", # Consistent docutils constraint
27
+ "Sphinx>=7,<8.2", # Consistent docutils constraint and sphinxcontrib-bibtex compatibility
28
28
  "PyYAML",
29
29
  "GitPython",
30
30
  "requests",
@@ -66,7 +66,7 @@ guide = [
66
66
  "sphinx-autodoc-typehints",
67
67
  "sphinx-automodapi",
68
68
  "sphinx-copybutton",
69
- "sphinx-prompt",
69
+ "sphinx-prompt>=1.10.0,<2",
70
70
  "sphinx-jinja>=2", # namespace changed in 2.0
71
71
  "myst-parser",
72
72
  "myst-nb",
@@ -87,7 +87,7 @@ pipelines = [
87
87
  "sphinx-autodoc-typehints",
88
88
  "sphinx-automodapi",
89
89
  "sphinx-copybutton",
90
- "sphinx-prompt",
90
+ "sphinx-prompt>=1.10.0,<2",
91
91
  "sphinx-jinja>=2", # namespace changed in 2.0
92
92
  "myst-parser",
93
93
  "markdown-it-py[linkify]",
@@ -104,7 +104,7 @@ pipelines = [
104
104
  technote = [
105
105
  # Theme and extensions for technotes
106
106
  "technote>=0.9.0,<0.10.0",
107
- "sphinx-prompt",
107
+ "sphinx-prompt>=1.10.0,<2",
108
108
  "sphinxcontrib-mermaid",
109
109
  "sphinx-diagrams",
110
110
  "sphinx_design",
@@ -19,9 +19,9 @@
19
19
  }
20
20
 
21
21
  :root {
22
- --tn-component-text-font-family: 'Source Sans 3 VF', -apple-system,
23
- BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,
24
- Droid Sans, Helvetica Neue, sans-serif;
22
+ --tn-component-text-font-family:
23
+ 'Source Sans 3 VF', -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
24
+ Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
25
25
  --tn-component-text-color: var(--rsd-component-text-color);
26
26
  --tn-component-toc-header-color: var(--rsd-color-primary-600);
27
27
  --tn-component-sidebar-header-color: var(--rsd-color-primary-600);
@@ -67,8 +67,8 @@ html[data-theme='dark'] {
67
67
 
68
68
  :root {
69
69
  --pst-font-family-base: 'Source Sans Pro', var(--pst-font-family-base-system);
70
- --pst-font-family-heading: 'Source Sans Pro',
71
- var(--pst-font-family-base-system);
70
+ --pst-font-family-heading:
71
+ 'Source Sans Pro', var(--pst-font-family-base-system);
72
72
 
73
73
  /* Base font size; increased for pydata-sphinx-theme default. */
74
74
  font-size: 18px;
@@ -90,9 +90,9 @@
90
90
  src: url(731c8feefe13e72a8691.woff2) format("woff2");
91
91
  }
92
92
  :root {
93
- --tn-component-text-font-family: "Source Sans 3 VF", -apple-system,
94
- BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,
95
- Droid Sans, Helvetica Neue, sans-serif;
93
+ --tn-component-text-font-family:
94
+ "Source Sans 3 VF", -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
95
+ Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
96
96
  --tn-component-text-color: var(--rsd-component-text-color);
97
97
  --tn-component-toc-header-color: var(--rsd-color-primary-600);
98
98
  --tn-component-sidebar-header-color: var(--rsd-color-primary-600);
@@ -1 +1 @@
1
- {"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;0CAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;;;;EAAA;AAKA;EACE;EAEA;APuMF;;AOrMA;EACE;APwMF;;AAzNA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n --rsd-color-blue-500: #1c81a4;\n --rsd-color-gray-100: #dce0e3;\n --rsd-color-gray-500: #6a6e6e;\n --rsd-color-gray-800: #1f2121;\n --rsd-color-gray-900: #000000; /* Pure black. */\n --rsd-color-gray-000: #ffffff; /* Pure white. */\n --rsd-color-green-500: #3cae3f;\n --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n --rsd-color-orange-500: #ed4c4c;\n --rsd-color-primary-100: #f5f5f5;\n --rsd-color-primary-200: #d9f7f6;\n --rsd-color-primary-300: #b1f2ef;\n --rsd-color-primary-400: #00babc;\n --rsd-color-primary-500: #009fa1;\n --rsd-color-primary-600: #058b8c;\n --rsd-color-primary-700: #0c4a47;\n --rsd-color-primary-800: #313333;\n --rsd-color-purple-500: #583671;\n --rsd-color-red-500: #ed4c4c;\n --rsd-color-yellow-500: #ffe266;\n --rsd-component-footer-background-color: #f5f5f5;\n --rsd-component-header-background-color: #1f2121; /* Header background color. */\n --rsd-component-header-nav-text-color: #ffffff;\n --rsd-component-header-nav-text-hover-color: #00babc;\n --rsd-component-header-nav-menulist-text-color: #1f2121;\n --rsd-component-header-nav-menulist-background-color: #ffffff;\n --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n --rsd-component-page-background-color: #ffffff; /* Page background color */\n --rsd-component-service-card-background-color: #ffffff;\n --rsd-component-service-card-text-color: #1f2121;\n --rsd-component-text-color: #1f2121; /* Body text color */\n --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n --rsd-component-text-link-color: #146685;\n --rsd-component-text-link-hover-color: #1c81a4;\n --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: normal;\n font-stretch: normal;\n src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: italic;\n font-stretch: normal;\n src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n --tn-component-text-font-family: 'Source Sans 3 VF', -apple-system,\n BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,\n Droid Sans, Helvetica Neue, sans-serif;\n --tn-component-text-color: var(--rsd-component-text-color);\n --tn-component-toc-header-color: var(--rsd-color-primary-600);\n --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n :root {\n --tn-component-h1-weight: 600;\n --tn-component-h2-weight: 500;\n --tn-component-h3-weight: 600;\n --tn-component-h4-weight: 700;\n --tn-component-h5-weight: 800;\n --tn-component-h6-weight: 800;\n }\n}\n\n@media (max-width: 76rem) {\n :root {\n --tn-component-h1-size: 2.4rem;\n --tn-component-h2-size: 1.8rem;\n --tn-component-h3-size: 1.2rem;\n --tn-component-h4-size: 1rem;\n --tn-component-h5-size: 1rem;\n --tn-component-h6-size: 1rem;\n }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n font-size: 1.1em;\n font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n list-style: none;\n margin-left: 0;\n padding-left: 0;\n margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n content: '';\n}\n\n.technote-article-header-id {\n margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n display: flex;\n flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n .rubin-technote-version-info a {\n font-weight: 500;\n }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n .technote-sidebar-section__heading {\n font-weight: 600;\n text-transform: uppercase;\n letter-spacing: 0.01em; // goes well with upper case\n }\n}\n",".mobile-rubin-technote-logo {\n display: block;\n margin: 0 auto 2rem auto;\n width: 100%;\n max-width: 12rem;\n}\n\n@media (max-width: 76em) {\n // When the primary sidebar is hidden, remove extra top margin from the\n // container so the logo is closer to the top.\n .sb-container {\n margin-top: 0;\n }\n}\n\n@media (min-width: 76em) {\n // Hide the mobile logo when the primary sidebar is visible.\n .mobile-rubin-technote-logo {\n display: none;\n margin: 0;\n }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n/*\n * Border specifically for prompt-type code blocks, which act differently\n * than code blocks. The prompt extension is used specially by Documenteer\n * technotes.\n */\n.highlight-default .highlight {\n border: var(--tn-sphinx-code-block-border-thickness) solid\n var(--tn-sphinx-code-block-border-color);\n border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n margin: 1em;\n}\n"],"names":[],"sourceRoot":""}
1
+ {"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;gFAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;;;;EAAA;AAKA;EACE;EAEA;APuMF;;AOrMA;EACE;APwMF;;AAzNA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n --rsd-color-blue-500: #1c81a4;\n --rsd-color-gray-100: #dce0e3;\n --rsd-color-gray-500: #6a6e6e;\n --rsd-color-gray-800: #1f2121;\n --rsd-color-gray-900: #000000; /* Pure black. */\n --rsd-color-gray-000: #ffffff; /* Pure white. */\n --rsd-color-green-500: #3cae3f;\n --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n --rsd-color-orange-500: #ed4c4c;\n --rsd-color-primary-100: #f5f5f5;\n --rsd-color-primary-200: #d9f7f6;\n --rsd-color-primary-300: #b1f2ef;\n --rsd-color-primary-400: #00babc;\n --rsd-color-primary-500: #009fa1;\n --rsd-color-primary-600: #058b8c;\n --rsd-color-primary-700: #0c4a47;\n --rsd-color-primary-800: #313333;\n --rsd-color-purple-500: #583671;\n --rsd-color-red-500: #ed4c4c;\n --rsd-color-yellow-500: #ffe266;\n --rsd-component-footer-background-color: #f5f5f5;\n --rsd-component-header-background-color: #1f2121; /* Header background color. */\n --rsd-component-header-nav-text-color: #ffffff;\n --rsd-component-header-nav-text-hover-color: #00babc;\n --rsd-component-header-nav-menulist-text-color: #1f2121;\n --rsd-component-header-nav-menulist-background-color: #ffffff;\n --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n --rsd-component-page-background-color: #ffffff; /* Page background color */\n --rsd-component-service-card-background-color: #ffffff;\n --rsd-component-service-card-text-color: #1f2121;\n --rsd-component-text-color: #1f2121; /* Body text color */\n --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n --rsd-component-text-link-color: #146685;\n --rsd-component-text-link-hover-color: #1c81a4;\n --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: normal;\n font-stretch: normal;\n src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: italic;\n font-stretch: normal;\n src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n --tn-component-text-font-family:\n 'Source Sans 3 VF', -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,\n Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;\n --tn-component-text-color: var(--rsd-component-text-color);\n --tn-component-toc-header-color: var(--rsd-color-primary-600);\n --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n :root {\n --tn-component-h1-weight: 600;\n --tn-component-h2-weight: 500;\n --tn-component-h3-weight: 600;\n --tn-component-h4-weight: 700;\n --tn-component-h5-weight: 800;\n --tn-component-h6-weight: 800;\n }\n}\n\n@media (max-width: 76rem) {\n :root {\n --tn-component-h1-size: 2.4rem;\n --tn-component-h2-size: 1.8rem;\n --tn-component-h3-size: 1.2rem;\n --tn-component-h4-size: 1rem;\n --tn-component-h5-size: 1rem;\n --tn-component-h6-size: 1rem;\n }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n font-size: 1.1em;\n font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n list-style: none;\n margin-left: 0;\n padding-left: 0;\n margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n content: '';\n}\n\n.technote-article-header-id {\n margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n display: flex;\n flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n .rubin-technote-version-info a {\n font-weight: 500;\n }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n .technote-sidebar-section__heading {\n font-weight: 600;\n text-transform: uppercase;\n letter-spacing: 0.01em; // goes well with upper case\n }\n}\n",".mobile-rubin-technote-logo {\n display: block;\n margin: 0 auto 2rem auto;\n width: 100%;\n max-width: 12rem;\n}\n\n@media (max-width: 76em) {\n // When the primary sidebar is hidden, remove extra top margin from the\n // container so the logo is closer to the top.\n .sb-container {\n margin-top: 0;\n }\n}\n\n@media (min-width: 76em) {\n // Hide the mobile logo when the primary sidebar is visible.\n .mobile-rubin-technote-logo {\n display: none;\n margin: 0;\n }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n/*\n * Border specifically for prompt-type code blocks, which act differently\n * than code blocks. The prompt extension is used specially by Documenteer\n * technotes.\n */\n.highlight-default .highlight {\n border: var(--tn-sphinx-code-block-border-thickness) solid\n var(--tn-sphinx-code-block-border-color);\n border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n margin: 1em;\n}\n"],"names":[],"sourceRoot":""}
@@ -45,9 +45,9 @@ def display_help(
45
45
 
46
46
  # Subtopic handling. This requires some care with typing, since the
47
47
  # commands attribute (although present) is not documented, and the
48
- # get_command method is only available on MultiCommands.
48
+ # get_command method is only available on Groups.
49
49
  group = main.commands[topic]
50
- if isinstance(group, click.MultiCommand):
50
+ if isinstance(group, click.Group):
51
51
  command = group.get_command(ctx, subtopic)
52
52
  if command:
53
53
  ctx.info_name = f"{topic} {subtopic}"
@@ -137,7 +137,7 @@ extensions = [
137
137
  "sphinx.ext.intersphinx",
138
138
  "sphinx.ext.todo",
139
139
  "sphinx.ext.ifconfig",
140
- "sphinx-prompt",
140
+ "sphinx_prompt",
141
141
  "sphinx_jinja",
142
142
  "sphinxcontrib.redoc",
143
143
  "sphinxcontrib.youtube",