documenteer 2.0.0a2__tar.gz → 2.0.0a4__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 (240) hide show
  1. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.github/SUPPORT.md +1 -1
  2. documenteer-2.0.0a4/.github/workflows/ci-cron.yaml +195 -0
  3. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.github/workflows/ci.yaml +71 -16
  4. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.pre-commit-config.yaml +0 -6
  5. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.prettierignore +2 -0
  6. documenteer-2.0.0a4/Makefile +25 -0
  7. {documenteer-2.0.0a2/src/documenteer.egg-info → documenteer-2.0.0a4}/PKG-INFO +18 -49
  8. documenteer-2.0.0a4/changelog.d/20241010_133336_danfuchs_mermaid_compat.md +4 -0
  9. documenteer-2.0.0a4/changelog.d/20250203_175511_jsick_DM_48755.md +3 -0
  10. documenteer-2.0.0a4/changelog.d/20250219_160628_jsick_DM_49037.md +19 -0
  11. documenteer-2.0.0a4/changelog.d/20250224_102742_jsick_graphviz_ci.md +17 -0
  12. documenteer-2.0.0a4/changelog.d/20250625_141008_jsick_DM_51536.md +17 -0
  13. documenteer-2.0.0a4/changelog.d/20250630_113114_jsick_update_theme.md +18 -0
  14. documenteer-2.0.0a4/changelog.d/20250703_103944_jsick_DM_51688.md +23 -0
  15. documenteer-2.0.0a4/changelog.d/20250710_133037_jsick_DM_51727.md +17 -0
  16. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/Makefile +1 -1
  17. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/_rst_epilog.rst +2 -2
  18. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/edit-on-github.rst +1 -1
  19. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/migrate.rst +4 -4
  20. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/start-a-technote.rst +1 -1
  21. documenteer-2.0.0a4/licenses/README.md +9 -0
  22. documenteer-2.0.0a4/licenses/sphinxcontrib-redoc.txt +23 -0
  23. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/package-lock.json +22 -0
  24. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/package.json +1 -0
  25. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/pyproject.toml +48 -36
  26. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/_properties.scss +3 -3
  27. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-pydata-theme.css +18 -11
  28. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-technote.css +3 -3
  29. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-technote.css.map +1 -1
  30. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/cli.py +12 -9
  31. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/conf/guide.py +45 -25
  32. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/conf/technote.py +14 -0
  33. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/bibtex.py +10 -1
  34. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/githubbibcache.py +3 -2
  35. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/jira.py +10 -1
  36. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/lsstdocushare.py +10 -1
  37. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/mockcoderefs.py +10 -1
  38. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/openapi.py +3 -2
  39. documenteer-2.0.0a4/src/documenteer/ext/redoc/__init__.py +5 -0
  40. documenteer-2.0.0a4/src/documenteer/ext/redoc/_redoc.py +131 -0
  41. documenteer-2.0.0a4/src/documenteer/ext/redoc/assets/redoc.html.jinja2 +36 -0
  42. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/remotecodeblock.py +5 -3
  43. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/services/technoteauthor.py +7 -17
  44. documenteer-2.0.0a4/src/documenteer/storage/authordb.py +102 -0
  45. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/technotetoml.py +12 -12
  46. {documenteer-2.0.0a2 → documenteer-2.0.0a4/src/documenteer.egg-info}/PKG-INFO +18 -49
  47. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer.egg-info/SOURCES.txt +18 -0
  48. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer.egg-info/requires.txt +7 -23
  49. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/conftest.py +0 -6
  50. documenteer-2.0.0a4/tests/ext/redoc_test.py +88 -0
  51. documenteer-2.0.0a4/tests/roots/test-redoc/_static/openapi.json +1 -0
  52. documenteer-2.0.0a4/tests/roots/test-redoc/api.rst +5 -0
  53. documenteer-2.0.0a4/tests/roots/test-redoc/conf.py +1 -0
  54. documenteer-2.0.0a4/tests/roots/test-redoc/documenteer.toml +10 -0
  55. documenteer-2.0.0a4/tests/roots/test-redoc/index.rst +8 -0
  56. documenteer-2.0.0a4/tests/services/technotemigration_test.py +104 -0
  57. documenteer-2.0.0a4/tests/storage/authordb_test.py +65 -0
  58. documenteer-2.0.0a4/tests/storage/technotetoml_test.py +125 -0
  59. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tox.ini +17 -6
  60. documenteer-2.0.0a2/.github/workflows/ci-cron.yaml +0 -102
  61. documenteer-2.0.0a2/Makefile +0 -18
  62. documenteer-2.0.0a2/licenses/README.md +0 -4
  63. documenteer-2.0.0a2/src/documenteer/storage/authordb.py +0 -168
  64. documenteer-2.0.0a2/tests/services/technotemigration_test.py +0 -73
  65. documenteer-2.0.0a2/tests/storage/authordb_test.py +0 -34
  66. documenteer-2.0.0a2/tests/storage/technotetoml_test.py +0 -59
  67. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.flake8 +0 -0
  68. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.github/CODE_OF_CONDUCT.md +0 -0
  69. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.github/CONTRIBUTING.md +0 -0
  70. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.github/dependabot.yml +0 -0
  71. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.gitignore +0 -0
  72. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.npmrc +0 -0
  73. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.nvmrc +0 -0
  74. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.prettierrc.yaml +0 -0
  75. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.vscode/settings.json +0 -0
  76. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/.vscode/tasks.json +0 -0
  77. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/CHANGELOG.md +0 -0
  78. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/LICENSE +0 -0
  79. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/MANIFEST.in +0 -0
  80. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/README.md +0 -0
  81. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/changelog.d/20240819_152413_jsick_DM_45803.md +0 -0
  82. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/changelog.d/_template.md.jinja +0 -0
  83. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/.gitignore +0 -0
  84. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/Makefile +0 -0
  85. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/conf.py +0 -0
  86. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/diagram.py +0 -0
  87. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
  88. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/index.ipynb +0 -0
  89. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
  90. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/ipynb-technote/technote.toml +0 -0
  91. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/.gitignore +0 -0
  92. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/Makefile +0 -0
  93. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/conf.py +0 -0
  94. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/diagram.py +0 -0
  95. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/index.md +0 -0
  96. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/md-technote/technote.toml +0 -0
  97. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/.gitignore +0 -0
  98. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/Makefile +0 -0
  99. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/conf.py +0 -0
  100. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/diagram.py +0 -0
  101. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/index.rst +0 -0
  102. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/demo/rst-technote/technote.toml +0 -0
  103. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/.gitignore +0 -0
  104. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/changelog.md +0 -0
  105. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/conf.py +0 -0
  106. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/api/documenteer.conf.rst +0 -0
  107. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/api/documenteer.ext.rst +0 -0
  108. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/api/documenteer.requestsutils.rst +0 -0
  109. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/api/index.rst +0 -0
  110. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/development.rst +0 -0
  111. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/html-templates.rst +0 -0
  112. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/index.rst +0 -0
  113. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/release.rst +0 -0
  114. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/theme-assets.rst +0 -0
  115. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/dev/theme.rst +0 -0
  116. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/documenteer.toml +0 -0
  117. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/badges.rst +0 -0
  118. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/configuration-preset.rst +0 -0
  119. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/configuration.rst +0 -0
  120. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/diagrams.rst +0 -0
  121. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/extend-conf-py.rst +0 -0
  122. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/including-notebooks.ipynb +0 -0
  123. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/index.rst +0 -0
  124. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/markdown-primer.md +0 -0
  125. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/openapi.rst +0 -0
  126. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/organization.rst +0 -0
  127. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/overview.rst +0 -0
  128. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/page-redirects.rst +0 -0
  129. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/pyproject-configuration.rst +0 -0
  130. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/rst-epilog.rst +0 -0
  131. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/tabsets.rst +0 -0
  132. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/toml-reference.rst +0 -0
  133. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/guides/video-embeds.rst +0 -0
  134. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/index.rst +0 -0
  135. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  136. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  137. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/index.rst +0 -0
  138. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/jira-reference.rst +0 -0
  139. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  140. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/openapi.rst +0 -0
  141. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  142. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/_templates/README.md +0 -0
  143. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/_templates/README.rst +0 -0
  144. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/author-metadata.rst +0 -0
  145. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/configuration.rst +0 -0
  146. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/document-status.rst +0 -0
  147. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/edit-locally.rst +0 -0
  148. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/extensions.rst +0 -0
  149. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  150. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/index.rst +0 -0
  151. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/docs/technotes/wide-content.rst +0 -0
  152. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/licenses/astropy-helpers.txt +0 -0
  153. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/licenses/sphinx-issue.txt +0 -0
  154. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/licenses/sphinx.txt +0 -0
  155. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/postcss.config.js +0 -0
  156. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/ruff-shared.toml +0 -0
  157. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/setup.cfg +0 -0
  158. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  159. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  160. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  161. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  162. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  163. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  164. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  165. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  166. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  167. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  168. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/__init__.py +0 -0
  169. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/.gitignore +0 -0
  170. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  171. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  172. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/favicon.ico +0 -0
  173. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  174. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  175. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  176. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-favicon.svg +0 -0
  177. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  178. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  179. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  180. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  181. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/conf/__init__.py +0 -0
  182. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/conf/_toml.py +0 -0
  183. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/conf/_utils.py +0 -0
  184. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/ext/__init__.py +0 -0
  185. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/packagemetadata.py +0 -0
  186. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/py.typed +0 -0
  187. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/requestsutils.py +0 -0
  188. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/services/__init__.py +0 -0
  189. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/services/technotemigration.py +0 -0
  190. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/__init__.py +0 -0
  191. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/latex.py +0 -0
  192. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  193. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  194. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  195. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
  196. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  197. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  198. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  199. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  200. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  201. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/storage/localtemplates.py +0 -0
  202. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/pydata/autosummary_core/exception.rst +0 -0
  203. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +0 -0
  204. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/pydata/layout.html +0 -0
  205. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/.gitkeep +0 -0
  206. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  207. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  208. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  209. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  210. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  211. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/utils.py +0 -0
  212. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer/version.py +0 -0
  213. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer.egg-info/dependency_links.txt +0 -0
  214. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer.egg-info/entry_points.txt +0 -0
  215. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/src/documenteer.egg-info/top_level.txt +0 -0
  216. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/__init__.py +0 -0
  217. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/afw.doxygen.conf +0 -0
  218. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/authordb.yaml +0 -0
  219. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/doxygen.tag.zip +0 -0
  220. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  221. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  222. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  223. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  224. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  225. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/include/README.md +0 -0
  226. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_alpha/src/README.md +0 -0
  227. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/data/package_beta/doc/README.md +0 -0
  228. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/ext/__init__.py +0 -0
  229. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/ext/jira_test.py +0 -0
  230. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/ext/lsstdocushare_test.py +0 -0
  231. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/ext/mockcoderefs_test.py +0 -0
  232. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/packagemetadata_test.py +0 -0
  233. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/roots/test-autocppapi/conf.py +0 -0
  234. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  235. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/roots/test-autocppapi/index.rst +0 -0
  236. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/services/__init__.py +0 -0
  237. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/storage/__init__.py +0 -0
  238. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/test_conf_toml.py +0 -0
  239. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/tests/test_conf_utils.py +0 -0
  240. {documenteer-2.0.0a2 → documenteer-2.0.0a4}/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)
@@ -0,0 +1,195 @@
1
+ # This is a separate run of the Python test suite that doesn't cache the tox
2
+ # environment and runs from a schedule. The purpose is to test compatibility
3
+ # with the latest versions of dependencies.
4
+
5
+ name: Periodic CI
6
+
7
+ env:
8
+ PYTHON_VERSION: "3.13"
9
+
10
+ "on":
11
+ schedule:
12
+ - cron: "0 12 * * 1"
13
+ workflow_dispatch: {}
14
+
15
+ jobs:
16
+ lint:
17
+ runs-on: ubuntu-latest
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+
21
+ - name: Set up Python
22
+ uses: actions/setup-python@v5
23
+ with:
24
+ python-version: ${{ env.PYTHON_VERSION }}
25
+
26
+ - uses: actions/setup-node@v4
27
+ with:
28
+ cache: 'npm'
29
+ node-version-file: '.nvmrc'
30
+
31
+ - name: Authenticate GitHub Packages
32
+ run: |
33
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
34
+ env:
35
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36
+
37
+ - name: npm install and build
38
+ run: |
39
+ npm install
40
+ npm run build
41
+
42
+ - name: Run tox
43
+ uses: lsst-sqre/run-tox@v1
44
+ with:
45
+ python-version: ${{ env.PYTHON_VERSION }}
46
+ tox-envs: 'lint'
47
+ use-cache: false
48
+ tox-plugins: tox-uv
49
+
50
+ - name: Report status
51
+ if: failure()
52
+ uses: ravsamhq/notify-slack-action@v2
53
+ with:
54
+ status: ${{ job.status }}
55
+ notify_when: "failure"
56
+ notification_title: "Periodic lint for {repo} failed"
57
+ env:
58
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
59
+
60
+ test:
61
+ runs-on: ubuntu-latest
62
+
63
+ strategy:
64
+ matrix:
65
+ python-version:
66
+ - "3.12"
67
+ - "3.13"
68
+ sphinx-version:
69
+ - "7"
70
+ - "8"
71
+ - "dev"
72
+
73
+ steps:
74
+ - uses: actions/checkout@v4
75
+ with:
76
+ fetch-depth: 0 # full history for setuptools_scm
77
+
78
+ - uses: actions/setup-node@v4
79
+ with:
80
+ node-version-file: '.nvmrc'
81
+
82
+ - name: Authenticate GitHub Packages
83
+ run: |
84
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
85
+ env:
86
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87
+
88
+ - name: npm install and build
89
+ run: |
90
+ npm install
91
+ npm run build
92
+
93
+ - name: Setup Graphviz
94
+ uses: ts-graphviz/setup-graphviz@v2
95
+
96
+ - name: Run tests in tox
97
+ uses: lsst-sqre/run-tox@v1
98
+ with:
99
+ python-version: ${{ matrix.python-version }}
100
+ tox-envs: "typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
101
+ use-cache: false
102
+ tox-plugins: tox-uv
103
+
104
+ - name: Report status
105
+ if: failure()
106
+ uses: ravsamhq/notify-slack-action@v2
107
+ with:
108
+ status: ${{ job.status }}
109
+ notify_when: "failure"
110
+ notification_title: "Periodic test for {repo} failed"
111
+ env:
112
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
113
+
114
+ docs:
115
+ runs-on: ubuntu-latest
116
+
117
+ steps:
118
+ - uses: actions/checkout@v4
119
+ with:
120
+ fetch-depth: 0 # full history for setuptools_scm
121
+
122
+ - uses: actions/setup-node@v4
123
+ with:
124
+ cache: 'npm'
125
+ node-version-file: '.nvmrc'
126
+
127
+ - name: Authenticate GitHub Packages
128
+ run: |
129
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
130
+ env:
131
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
132
+
133
+ - name: npm install and build
134
+ run: |
135
+ npm install
136
+ npm run build
137
+
138
+ - name: Setup Graphviz
139
+ uses: ts-graphviz/setup-graphviz@v2
140
+
141
+ - name: Build docs in tox
142
+ uses: lsst-sqre/run-tox@v1
143
+ with:
144
+ python-version: ${{ env.PYTHON_VERSION }}
145
+ tox-envs: "docs,docs-lint"
146
+ use-cache: false
147
+ tox-plugins: tox-uv
148
+
149
+ - name: Report status
150
+ if: failure()
151
+ uses: ravsamhq/notify-slack-action@v2
152
+ with:
153
+ status: ${{ job.status }}
154
+ notify_when: "failure"
155
+ notification_title: "Periodic documentation test for {repo} failed"
156
+ env:
157
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
158
+
159
+ pypi:
160
+ runs-on: ubuntu-latest
161
+
162
+ steps:
163
+ - uses: actions/checkout@v4
164
+ with:
165
+ fetch-depth: 0 # full history for setuptools_scm
166
+
167
+ - uses: actions/setup-node@v4
168
+ with:
169
+ node-version-file: '.nvmrc'
170
+
171
+ - name: Authenticate GitHub Packages
172
+ run: |
173
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
174
+ env:
175
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
176
+
177
+ - name: npm install and build
178
+ run: |
179
+ npm install
180
+ npm run build
181
+
182
+ - name: Build and publish
183
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
184
+ with:
185
+ upload: false
186
+
187
+ - name: Report status
188
+ if: failure()
189
+ uses: ravsamhq/notify-slack-action@v2
190
+ with:
191
+ status: ${{ job.status }}
192
+ notify_when: "failure"
193
+ notification_title: "Periodic packaging test for {repo} failed"
194
+ env:
195
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
@@ -1,7 +1,7 @@
1
1
  name: CI
2
2
 
3
3
  env:
4
- PYTHON_VERSION: '3.12' # Default Python version
4
+ PYTHON_VERSION: '3.13' # Default Python version
5
5
 
6
6
  'on':
7
7
  push:
@@ -27,10 +27,30 @@ jobs:
27
27
  - name: Set up Python
28
28
  uses: actions/setup-python@v5
29
29
  with:
30
- python-version: '3.12'
30
+ python-version: ${{ env.PYTHON_VERSION }}
31
+
32
+ - uses: actions/setup-node@v4
33
+ with:
34
+ cache: 'npm'
35
+ node-version-file: '.nvmrc'
36
+
37
+ - name: Authenticate GitHub Packages
38
+ run: |
39
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
40
+ env:
41
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42
+
43
+ - name: npm install and build
44
+ run: |
45
+ npm install
46
+ npm run build
31
47
 
32
- - name: Run pre-commit
33
- uses: pre-commit/action@v3.0.1
48
+ - name: Run tox
49
+ uses: lsst-sqre/run-tox@v1
50
+ with:
51
+ python-version: ${{ env.PYTHON_VERSION }}
52
+ tox-envs: 'lint'
53
+ tox-plugins: tox-uv
34
54
 
35
55
  test:
36
56
  runs-on: ubuntu-latest
@@ -38,8 +58,8 @@ jobs:
38
58
  strategy:
39
59
  matrix:
40
60
  python-version:
41
- - '3.11'
42
61
  - '3.12'
62
+ - '3.13'
43
63
  sphinx-version:
44
64
  - '7'
45
65
  - '8'
@@ -65,16 +85,15 @@ jobs:
65
85
  npm install
66
86
  npm run build
67
87
 
68
- - name: Install graphviz
69
- run: |
70
- sudo apt-get update
71
- sudo apt-get install graphviz
88
+ - name: Setup Graphviz
89
+ uses: ts-graphviz/setup-graphviz@v2
72
90
 
73
91
  - name: Run tox
74
92
  uses: lsst-sqre/run-tox@v1
75
93
  with:
76
94
  python-version: ${{ matrix.python-version }}
77
95
  tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
96
+ tox-plugins: tox-uv
78
97
 
79
98
  docs:
80
99
  runs-on: ubuntu-latest
@@ -84,14 +103,31 @@ jobs:
84
103
  with:
85
104
  fetch-depth: 0 # full history for setuptools_scm
86
105
 
87
- - name: Install Graphviz
88
- run: sudo apt-get install graphviz
106
+ - name: Setup Graphviz
107
+ uses: ts-graphviz/setup-graphviz@v2
108
+
109
+ - uses: actions/setup-node@v4
110
+ with:
111
+ cache: 'npm'
112
+ node-version-file: '.nvmrc'
113
+
114
+ - name: Authenticate GitHub Packages
115
+ run: |
116
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
117
+ env:
118
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
119
+
120
+ - name: npm install and build
121
+ run: |
122
+ npm install
123
+ npm run build
89
124
 
90
125
  - name: Run tox
91
126
  uses: lsst-sqre/run-tox@v1
92
127
  with:
93
128
  python-version: ${{ env.PYTHON_VERSION }}
94
129
  tox-envs: 'docs,docs-lint'
130
+ tox-plugins: tox-uv
95
131
 
96
132
  # Only attempt documentation uploads for tagged releases and pull
97
133
  # requests from ticket branches in the same repository. This avoids
@@ -116,10 +152,25 @@ jobs:
116
152
  with:
117
153
  fetch-depth: 0 # full history for setuptools_scm
118
154
 
155
+ - uses: actions/setup-node@v4
156
+ with:
157
+ cache: 'npm'
158
+ node-version-file: '.nvmrc'
159
+
160
+ - name: Authenticate GitHub Packages
161
+ run: |
162
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
163
+ env:
164
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
165
+
166
+ - name: npm install and build
167
+ run: |
168
+ npm install
169
+ npm run build
170
+
119
171
  - name: Build and publish
120
- uses: lsst-sqre/build-and-publish-to-pypi@v2
172
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
121
173
  with:
122
- python-version: ${{ env.PYTHON_VERSION }}
123
174
  upload: "false"
124
175
 
125
176
  pypi-publish:
@@ -143,12 +194,16 @@ jobs:
143
194
  cache: 'npm'
144
195
  node-version-file: '.nvmrc'
145
196
 
197
+ - name: Authenticate GitHub Packages
198
+ run: |
199
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
200
+ env:
201
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
202
+
146
203
  - name: npm install and build
147
204
  run: |
148
205
  npm install
149
206
  npm run build
150
207
 
151
208
  - name: Build and publish
152
- uses: lsst-sqre/build-and-publish-to-pypi@v2
153
- with:
154
- python-version: ${{ env.PYTHON_VERSION }}
209
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
@@ -27,9 +27,3 @@ repos:
27
27
  - id: blacken-docs
28
28
  additional_dependencies: [black==24.4.2]
29
29
  args: [-l, '79', -t, py312]
30
-
31
- - repo: https://github.com/pre-commit/mirrors-prettier
32
- rev: v4.0.0-alpha.8
33
- hooks:
34
- - id: prettier
35
- 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
@@ -0,0 +1,25 @@
1
+ .PHONY: help
2
+ help:
3
+ @echo "Make command reference"
4
+ @echo " make init ........ (initialize for development)"
5
+ @echo " make clean ....... (clean up build artifacts)"
6
+ @echo " make update-deps . (update dependencies and pre-commit hooks)"
7
+
8
+ .PHONY: init
9
+ init:
10
+ rm -rf .tox
11
+ uv pip install --upgrade pre-commit tox tox-uv scriv
12
+ uv pip install -e ".[technote,pipelines]" --group dev
13
+ pre-commit install
14
+
15
+ .PHONY: clean
16
+ clean:
17
+ rm -rf .tox
18
+ rm -rf docs/_build
19
+ rm -rf docs/dev/api/contents/*.rst
20
+ make -C demo/rst-technote clean
21
+
22
+ .PHONY: update-deps
23
+ update-deps:
24
+ uv pip install --upgrade pre-commit
25
+ pre-commit autoupdate
@@ -1,29 +1,8 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: documenteer
3
- Version: 2.0.0a2
3
+ Version: 2.0.0a4
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
@@ -31,50 +10,39 @@ Classifier: Development Status :: 5 - Production/Stable
31
10
  Classifier: Environment :: Console
32
11
  Classifier: Framework :: Sphinx :: Extension
33
12
  Classifier: Intended Audience :: Developers
34
- Classifier: License :: OSI Approved :: MIT License
35
13
  Classifier: Natural Language :: English
36
14
  Classifier: Operating System :: POSIX
37
15
  Classifier: Programming Language :: Python
38
16
  Classifier: Programming Language :: Python :: 3
39
- Classifier: Programming Language :: Python :: 3.11
40
17
  Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
41
19
  Classifier: Topic :: Documentation
42
20
  Classifier: Topic :: Documentation :: Sphinx
43
21
  Classifier: Typing :: Typed
44
- Requires-Python: >=3.11
22
+ Requires-Python: >=3.12
45
23
  Description-Content-Type: text/markdown
46
24
  License-File: LICENSE
25
+ License-File: licenses/README.md
26
+ License-File: licenses/astropy-helpers.txt
27
+ License-File: licenses/sphinx-issue.txt
28
+ License-File: licenses/sphinx.txt
29
+ License-File: licenses/sphinxcontrib-redoc.txt
47
30
  Requires-Dist: docutils>=0.20
48
- Requires-Dist: Sphinx>=7
31
+ Requires-Dist: Sphinx<8.2,>=7
49
32
  Requires-Dist: PyYAML
50
33
  Requires-Dist: GitPython
51
34
  Requires-Dist: requests
52
35
  Requires-Dist: click
53
- Requires-Dist: sphinxcontrib-bibtex>=2.0.0
54
- Requires-Dist: setuptools
36
+ Requires-Dist: sphinxcontrib-bibtex>=2.6.5
37
+ Requires-Dist: pybtex>=0.25.0
55
38
  Requires-Dist: pydantic>=2.0.0
56
39
  Requires-Dist: urllib3
57
40
  Requires-Dist: pylatexenc
58
41
  Requires-Dist: tomlkit
59
- Provides-Extra: dev
60
- Requires-Dist: twine; extra == "dev"
61
- Requires-Dist: coverage[toml]; extra == "dev"
62
- Requires-Dist: pytest; extra == "dev"
63
- Requires-Dist: pytest-mock; extra == "dev"
64
- Requires-Dist: lxml; extra == "dev"
65
- Requires-Dist: cssselect; extra == "dev"
66
- Requires-Dist: defusedxml; extra == "dev"
67
- Requires-Dist: sphinx-click; extra == "dev"
68
- Requires-Dist: sphinxcontrib-autoprogram; extra == "dev"
69
- Requires-Dist: types-setuptools; extra == "dev"
70
- Requires-Dist: types-requests; extra == "dev"
71
- Requires-Dist: types-PyYAML; extra == "dev"
72
- Requires-Dist: types-docutils; extra == "dev"
73
- Requires-Dist: types-mock; extra == "dev"
74
42
  Provides-Extra: guide
75
43
  Requires-Dist: autodoc_pydantic; extra == "guide"
76
44
  Requires-Dist: sphinx_design; extra == "guide"
77
- Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
45
+ Requires-Dist: pydata-sphinx-theme<0.17.0,>=0.16.1; extra == "guide"
78
46
  Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
79
47
  Requires-Dist: sphinx-automodapi; extra == "guide"
80
48
  Requires-Dist: sphinx-copybutton; extra == "guide"
@@ -83,20 +51,21 @@ Requires-Dist: sphinx-jinja>=2; extra == "guide"
83
51
  Requires-Dist: myst-parser; extra == "guide"
84
52
  Requires-Dist: myst-nb; extra == "guide"
85
53
  Requires-Dist: markdown-it-py[linkify]; extra == "guide"
86
- Requires-Dist: sphinxcontrib-mermaid; extra == "guide"
54
+ Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
87
55
  Requires-Dist: sphinxext-opengraph; extra == "guide"
88
- Requires-Dist: sphinxcontrib-redoc; extra == "guide"
89
56
  Requires-Dist: sphinxcontrib-jquery; extra == "guide"
90
57
  Requires-Dist: sphinxext-rediraffe; extra == "guide"
91
58
  Requires-Dist: sphinxcontrib-youtube; extra == "guide"
59
+ Requires-Dist: sphinx-favicon; extra == "guide"
92
60
  Provides-Extra: technote
93
61
  Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
94
62
  Requires-Dist: sphinx-prompt; extra == "technote"
95
- Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
63
+ Requires-Dist: sphinxcontrib-mermaid>=1; extra == "technote"
96
64
  Requires-Dist: sphinx-diagrams; extra == "technote"
97
65
  Requires-Dist: sphinx_design; extra == "technote"
98
66
  Requires-Dist: myst-nb; extra == "technote"
99
67
  Requires-Dist: sphinxcontrib-youtube; extra == "technote"
68
+ Dynamic: license-file
100
69
 
101
70
  [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
102
71
  [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
@@ -0,0 +1,4 @@
1
+ ### Bug fixes
2
+
3
+ - Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
4
+
@@ -0,0 +1,3 @@
1
+ ### Other changes
2
+
3
+ - Point to `@Squarebot` in the rubin-obs Slack in the documentation for creating a technote.
@@ -0,0 +1,19 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ -
6
+
7
+ ### New features
8
+
9
+ -
10
+
11
+ ### Bug fixes
12
+
13
+ - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
14
+
15
+ ### Other changes
16
+
17
+ - Drop use of the pre-commit hook for prettier, and instead run prettier directly from the tox lint environment. This change is necessary because the prettier hook for pre-commit is no longer supported.
18
+
19
+ - Add Python 3.13 to the test matrix.
@@ -0,0 +1,17 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ -
6
+
7
+ ### New features
8
+
9
+ -
10
+
11
+ ### Bug fixes
12
+
13
+ -
14
+
15
+ ### Other changes
16
+
17
+ - Adopt [ts-graphviz/setup-graphviz](https://github.com/ts-graphviz/setup-graphviz) for installing Graphviz in GitHub Actions CI workflows.
@@ -0,0 +1,17 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ - Dropped support for Python 3.11. Python 3.12 or later is now required.
6
+
7
+ ### New features
8
+
9
+ -
10
+
11
+ ### Bug fixes
12
+
13
+ -
14
+
15
+ ### Other changes
16
+
17
+ - Updated how license information is encoded in `pyproject.toml`.
@@ -0,0 +1,18 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ -
6
+
7
+ ### New features
8
+
9
+ - Update to pydata-sphinx-theme 0.16
10
+ - Adopt [sphinx-favicon](https://sphinx-favicon.readthedocs.io/en/stable/index.html) for managing favicons in user guides.
11
+
12
+ ### Bug fixes
13
+
14
+ -
15
+
16
+ ### Other changes
17
+
18
+ - Switch to dependency groups for development dependencies in `pyproject.toml`. With this change, Documenteer no longer publishes a `dev` extra to PyPI.
@@ -0,0 +1,23 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ -
6
+
7
+ ### New features
8
+
9
+ - For embedding a redoc page for API documentation, Documenteer now provides its own `documenteer.ext.redoc` extension. This replaces the previous `sphinxcontrib.redoc` extension, which is not being actively maintained. This new extension is automatically configured through `documenteer.conf.guide`, and therefore should not require any changes for most user guide projects. `documenteer.ext.redoc` drops support for referencing an OpenAPI specification file from a web URL. FastAPI projects can use `documenteer.ext.openapi` to generate an OpenAPI specification file from the FastAPI app.
10
+
11
+ - In Markdown content for technotes and guides, Mermaid diagrams can now be written in code fences using the `mermaid` language tag. This is also supported in GitHub's Markdown renderer. The traditional method of using the `mermaid` directive syntax is still supported.
12
+
13
+ - Documenteer's `technote` and `guide` configurations now ignore pending Sphinx API deprecation warnings by default. This is to prevent the warnings from cluttering the build output, and are only useful for the Documenteer developers since the Sphinx version is constrained by Documenteer.
14
+
15
+ ### Bug fixes
16
+
17
+ -
18
+
19
+ ### Other changes
20
+
21
+ - Documenteer no longer depends on setuptools as a runtime dependency thanks to pybtex version 0.25 and `documenteer.ext.redoc`.
22
+
23
+ - Documenteer's Sphinx extensions now provide proper extension metadata to support version-based cache busting and parallel builds.
@@ -0,0 +1,17 @@
1
+ <!-- Delete the sections that don't apply -->
2
+
3
+ ### Backwards-incompatible changes
4
+
5
+ -
6
+
7
+ ### New features
8
+
9
+ - The `documenteer` `add-authors` and `sync-authors` CLI commands now uses the Ook web API to get author information, rather than directly reading `authordb.yaml` from lsst/lsst-texmf.
10
+
11
+ ### Bug fixes
12
+
13
+ -
14
+
15
+ ### Other changes
16
+
17
+ -
@@ -1,7 +1,7 @@
1
1
  # Makefile for Sphinx documentation
2
2
 
3
3
  # You can set these variables from the command line.
4
- SPHINXOPTS = -n -W
4
+ SPHINXOPTS = -n
5
5
  SPHINXBUILD = sphinx-build
6
6
  BUILDDIR = _build
7
7
 
@@ -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/
@@ -63,7 +63,7 @@
63
63
  .. _pipx: https://pipx.pypa.io
64
64
  .. _`LSSTC Slack Workspace`: https://lsstc.slack.com
65
65
 
66
- .. |dmw-sqrbot| replace:: `direct message with @sqrbot-jr <https://slack.com/app_redirect?app=AF2U6ADV3&team=T06D204F2>`__
66
+ .. |dmw-squarebot| replace:: `direct message with @squarebot <https://slack.com/app_redirect?app=A07PWG9UG9M&team=T02SVMGU4>`__
67
67
 
68
68
  .. Internal links
69
69