documenteer 1.4.3__tar.gz → 2.0.0__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 (285) hide show
  1. documenteer-2.0.0/.github/workflows/ci-cron.yaml +195 -0
  2. {documenteer-1.4.3 → documenteer-2.0.0}/.github/workflows/ci.yaml +58 -19
  3. {documenteer-1.4.3 → documenteer-2.0.0}/.pre-commit-config.yaml +9 -19
  4. documenteer-2.0.0/.vscode/settings.json +4 -0
  5. {documenteer-1.4.3 → documenteer-2.0.0}/CHANGELOG.md +88 -0
  6. documenteer-2.0.0/Makefile +25 -0
  7. documenteer-2.0.0/PKG-INFO +97 -0
  8. {documenteer-1.4.3 → documenteer-2.0.0}/README.md +2 -8
  9. {documenteer-1.4.3 → documenteer-2.0.0}/docs/Makefile +0 -1
  10. {documenteer-1.4.3 → documenteer-2.0.0}/docs/_rst_epilog.rst +1 -6
  11. {documenteer-1.4.3 → documenteer-2.0.0}/docs/changelog.md +88 -0
  12. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/api/documenteer.ext.rst +0 -7
  13. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/api/index.rst +0 -3
  14. {documenteer-1.4.3 → documenteer-2.0.0}/docs/documenteer.toml +10 -8
  15. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/index.rst +0 -8
  16. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/page-redirects.rst +1 -1
  17. {documenteer-1.4.3 → documenteer-2.0.0}/docs/index.rst +1 -15
  18. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/index.rst +0 -10
  19. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/edit-on-github.rst +1 -1
  20. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/start-a-technote.rst +1 -1
  21. documenteer-2.0.0/licenses/README.md +9 -0
  22. documenteer-2.0.0/licenses/sphinxcontrib-redoc.txt +23 -0
  23. {documenteer-1.4.3 → documenteer-2.0.0}/pyproject.toml +112 -71
  24. documenteer-2.0.0/ruff-shared.toml +139 -0
  25. documenteer-1.4.3/src/documenteer/packagemetadata.py → documenteer-2.0.0/src/documenteer/_packagemetadata.py +9 -23
  26. documenteer-1.4.3/src/documenteer/requestsutils.py → documenteer-2.0.0/src/documenteer/_requestsutils.py +8 -7
  27. documenteer-1.4.3/src/documenteer/utils.py → documenteer-2.0.0/src/documenteer/_utils.py +11 -13
  28. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-pydata-theme.css +16 -9
  29. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/cli.py +13 -11
  30. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/conf/_toml.py +45 -55
  31. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/conf/_utils.py +4 -7
  32. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/conf/guide.py +102 -36
  33. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/conf/technote.py +19 -11
  34. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/bibtex.py +13 -2
  35. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/githubbibcache.py +4 -3
  36. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/jira.py +58 -35
  37. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/lsstdocushare.py +27 -17
  38. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/mockcoderefs.py +25 -4
  39. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/openapi.py +8 -7
  40. documenteer-2.0.0/src/documenteer/ext/redoc/__init__.py +5 -0
  41. documenteer-2.0.0/src/documenteer/ext/redoc/_redoc.py +131 -0
  42. documenteer-2.0.0/src/documenteer/ext/redoc/assets/redoc.html.jinja2 +36 -0
  43. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/remotecodeblock.py +29 -31
  44. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/services/technoteauthor.py +7 -15
  45. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/services/technotemigration.py +21 -14
  46. documenteer-2.0.0/src/documenteer/storage/authordb.py +102 -0
  47. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/conf.py +1 -1
  48. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates.py +1 -1
  49. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/technotetoml.py +15 -18
  50. documenteer-2.0.0/src/documenteer/templates/pydata/autosummary_core/exception.rst +15 -0
  51. documenteer-2.0.0/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +11 -0
  52. documenteer-2.0.0/src/documenteer.egg-info/PKG-INFO +97 -0
  53. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer.egg-info/SOURCES.txt +17 -53
  54. documenteer-2.0.0/src/documenteer.egg-info/entry_points.txt +2 -0
  55. documenteer-2.0.0/src/documenteer.egg-info/requires.txt +40 -0
  56. documenteer-2.0.0/tests/conftest.py +18 -0
  57. {documenteer-1.4.3 → documenteer-2.0.0}/tests/ext/jira_test.py +6 -5
  58. {documenteer-1.4.3 → documenteer-2.0.0}/tests/ext/lsstdocushare_test.py +7 -5
  59. {documenteer-1.4.3 → documenteer-2.0.0}/tests/ext/mockcoderefs_test.py +13 -11
  60. documenteer-2.0.0/tests/ext/redoc_test.py +88 -0
  61. {documenteer-1.4.3 → documenteer-2.0.0}/tests/packagemetadata_test.py +1 -1
  62. documenteer-2.0.0/tests/roots/test-redoc/_static/openapi.json +1 -0
  63. documenteer-2.0.0/tests/roots/test-redoc/api.rst +5 -0
  64. documenteer-2.0.0/tests/roots/test-redoc/conf.py +1 -0
  65. documenteer-2.0.0/tests/roots/test-redoc/documenteer.toml +10 -0
  66. documenteer-2.0.0/tests/roots/test-redoc/index.rst +8 -0
  67. documenteer-2.0.0/tests/services/technotemigration_test.py +104 -0
  68. documenteer-2.0.0/tests/storage/authordb_test.py +64 -0
  69. documenteer-2.0.0/tests/storage/technotetoml_test.py +125 -0
  70. {documenteer-1.4.3 → documenteer-2.0.0}/tests/test_conf_toml.py +3 -5
  71. {documenteer-1.4.3 → documenteer-2.0.0}/tox.ini +24 -11
  72. documenteer-1.4.3/.github/workflows/ci-cron.yaml +0 -98
  73. documenteer-1.4.3/.github/workflows/dependencies.yaml +0 -33
  74. documenteer-1.4.3/.vscode/settings.json +0 -6
  75. documenteer-1.4.3/Makefile +0 -18
  76. documenteer-1.4.3/PKG-INFO +0 -148
  77. documenteer-1.4.3/docs/dev/api/documenteer.requestsutils.rst +0 -6
  78. documenteer-1.4.3/docs/dev/api/documenteer.sphinxrunner.rst +0 -6
  79. documenteer-1.4.3/docs/dev/api/documenteer.stackdocs.rst +0 -21
  80. documenteer-1.4.3/docs/guides/pipelines/build-overview.rst +0 -112
  81. documenteer-1.4.3/docs/guides/pipelines/configuration.rst +0 -84
  82. documenteer-1.4.3/docs/guides/pipelines/cpp-api-linking.rst +0 -116
  83. documenteer-1.4.3/docs/guides/pipelines/index.rst +0 -17
  84. documenteer-1.4.3/docs/guides/pipelines/install.rst +0 -45
  85. documenteer-1.4.3/docs/guides/pipelines/package-docs-cli.rst +0 -15
  86. documenteer-1.4.3/docs/guides/pipelines/stack-docs-cli.rst +0 -15
  87. documenteer-1.4.3/docs/sphinx-extensions/autocppapi.rst +0 -69
  88. documenteer-1.4.3/docs/sphinx-extensions/autodocreset.rst +0 -22
  89. documenteer-1.4.3/docs/sphinx-extensions/lssttasks.rst +0 -376
  90. documenteer-1.4.3/docs/sphinx-extensions/package-toctree.rst +0 -76
  91. documenteer-1.4.3/licenses/README.md +0 -4
  92. documenteer-1.4.3/src/documenteer/conf/pipelines.py +0 -224
  93. documenteer-1.4.3/src/documenteer/conf/pipelinespkg.py +0 -15
  94. documenteer-1.4.3/src/documenteer/ext/_utils.py +0 -210
  95. documenteer-1.4.3/src/documenteer/ext/autocppapi.py +0 -307
  96. documenteer-1.4.3/src/documenteer/ext/autodocreset.py +0 -26
  97. documenteer-1.4.3/src/documenteer/ext/lssttasks/__init__.py +0 -84
  98. documenteer-1.4.3/src/documenteer/ext/lssttasks/configfieldlists.py +0 -1179
  99. documenteer-1.4.3/src/documenteer/ext/lssttasks/crossrefs.py +0 -397
  100. documenteer-1.4.3/src/documenteer/ext/lssttasks/pyapisummary.py +0 -320
  101. documenteer-1.4.3/src/documenteer/ext/lssttasks/taskutils.py +0 -221
  102. documenteer-1.4.3/src/documenteer/ext/lssttasks/topiclists.py +0 -276
  103. documenteer-1.4.3/src/documenteer/ext/lssttasks/topics.py +0 -169
  104. documenteer-1.4.3/src/documenteer/ext/packagetoctree.py +0 -245
  105. documenteer-1.4.3/src/documenteer/sphinxrunner.py +0 -69
  106. documenteer-1.4.3/src/documenteer/stackdocs/build.py +0 -307
  107. documenteer-1.4.3/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -35489
  108. documenteer-1.4.3/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -2414
  109. documenteer-1.4.3/src/documenteer/stackdocs/data/mainpage.dox +0 -9
  110. documenteer-1.4.3/src/documenteer/stackdocs/doxygen.py +0 -732
  111. documenteer-1.4.3/src/documenteer/stackdocs/doxygentag.py +0 -59
  112. documenteer-1.4.3/src/documenteer/stackdocs/packagecli.py +0 -142
  113. documenteer-1.4.3/src/documenteer/stackdocs/pkgdiscovery.py +0 -308
  114. documenteer-1.4.3/src/documenteer/stackdocs/rootdiscovery.py +0 -118
  115. documenteer-1.4.3/src/documenteer/stackdocs/stackcli.py +0 -342
  116. documenteer-1.4.3/src/documenteer/storage/authordb.py +0 -173
  117. documenteer-1.4.3/src/documenteer.egg-info/PKG-INFO +0 -148
  118. documenteer-1.4.3/src/documenteer.egg-info/entry_points.txt +0 -4
  119. documenteer-1.4.3/src/documenteer.egg-info/requires.txt +0 -73
  120. documenteer-1.4.3/tests/conftest.py +0 -21
  121. documenteer-1.4.3/tests/ext/autocppapi_test.py +0 -38
  122. documenteer-1.4.3/tests/ext/lssttasks/taskutils_test.py +0 -32
  123. documenteer-1.4.3/tests/ext/packagetoctree_test.py +0 -20
  124. documenteer-1.4.3/tests/ext/utils_test.py +0 -25
  125. documenteer-1.4.3/tests/services/technotemigration_test.py +0 -73
  126. documenteer-1.4.3/tests/storage/__init__.py +0 -0
  127. documenteer-1.4.3/tests/storage/authordb_test.py +0 -34
  128. documenteer-1.4.3/tests/storage/technotetoml_test.py +0 -60
  129. documenteer-1.4.3/tests/test_stackdocs_build.py +0 -77
  130. documenteer-1.4.3/tests/test_stackdocs_doxygen.py +0 -168
  131. documenteer-1.4.3/tests/test_stackdocs_doxygentag.py +0 -48
  132. documenteer-1.4.3/tests/test_stackdocs_pkgdiscovery.py +0 -65
  133. documenteer-1.4.3/tests/test_stackdocs_rootdiscovery.py +0 -117
  134. {documenteer-1.4.3 → documenteer-2.0.0}/.flake8 +0 -0
  135. {documenteer-1.4.3 → documenteer-2.0.0}/.github/CODE_OF_CONDUCT.md +0 -0
  136. {documenteer-1.4.3 → documenteer-2.0.0}/.github/CONTRIBUTING.md +0 -0
  137. {documenteer-1.4.3 → documenteer-2.0.0}/.github/SUPPORT.md +0 -0
  138. {documenteer-1.4.3 → documenteer-2.0.0}/.github/dependabot.yml +0 -0
  139. {documenteer-1.4.3 → documenteer-2.0.0}/.gitignore +0 -0
  140. {documenteer-1.4.3 → documenteer-2.0.0}/.npmrc +0 -0
  141. {documenteer-1.4.3 → documenteer-2.0.0}/.nvmrc +0 -0
  142. {documenteer-1.4.3 → documenteer-2.0.0}/.prettierignore +0 -0
  143. {documenteer-1.4.3 → documenteer-2.0.0}/.prettierrc.yaml +0 -0
  144. {documenteer-1.4.3 → documenteer-2.0.0}/.vscode/tasks.json +0 -0
  145. {documenteer-1.4.3 → documenteer-2.0.0}/LICENSE +0 -0
  146. {documenteer-1.4.3 → documenteer-2.0.0}/MANIFEST.in +0 -0
  147. {documenteer-1.4.3 → documenteer-2.0.0}/changelog.d/_template.md.jinja +0 -0
  148. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/.gitignore +0 -0
  149. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/Makefile +0 -0
  150. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/conf.py +0 -0
  151. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/diagram.py +0 -0
  152. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
  153. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/index.ipynb +0 -0
  154. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
  155. {documenteer-1.4.3 → documenteer-2.0.0}/demo/ipynb-technote/technote.toml +0 -0
  156. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/.gitignore +0 -0
  157. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/Makefile +0 -0
  158. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/conf.py +0 -0
  159. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/diagram.py +0 -0
  160. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/index.md +0 -0
  161. {documenteer-1.4.3 → documenteer-2.0.0}/demo/md-technote/technote.toml +0 -0
  162. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/.gitignore +0 -0
  163. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/Makefile +0 -0
  164. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/conf.py +0 -0
  165. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/diagram.py +0 -0
  166. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/index.rst +0 -0
  167. {documenteer-1.4.3 → documenteer-2.0.0}/demo/rst-technote/technote.toml +0 -0
  168. {documenteer-1.4.3 → documenteer-2.0.0}/docs/.gitignore +0 -0
  169. {documenteer-1.4.3 → documenteer-2.0.0}/docs/conf.py +0 -0
  170. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/api/documenteer.conf.rst +0 -0
  171. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/development.rst +0 -0
  172. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/html-templates.rst +0 -0
  173. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/index.rst +0 -0
  174. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/release.rst +0 -0
  175. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/theme-assets.rst +0 -0
  176. {documenteer-1.4.3 → documenteer-2.0.0}/docs/dev/theme.rst +0 -0
  177. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/badges.rst +0 -0
  178. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/configuration-preset.rst +0 -0
  179. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/configuration.rst +0 -0
  180. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/diagrams.rst +0 -0
  181. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/extend-conf-py.rst +0 -0
  182. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/including-notebooks.ipynb +0 -0
  183. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/markdown-primer.md +0 -0
  184. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/openapi.rst +0 -0
  185. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/organization.rst +0 -0
  186. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/overview.rst +0 -0
  187. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/pyproject-configuration.rst +0 -0
  188. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/rst-epilog.rst +0 -0
  189. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/tabsets.rst +0 -0
  190. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/toml-reference.rst +0 -0
  191. {documenteer-1.4.3 → documenteer-2.0.0}/docs/guides/video-embeds.rst +0 -0
  192. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  193. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  194. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/jira-reference.rst +0 -0
  195. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  196. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/openapi.rst +0 -0
  197. {documenteer-1.4.3 → documenteer-2.0.0}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  198. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/_templates/README.md +0 -0
  199. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/_templates/README.rst +0 -0
  200. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/author-metadata.rst +0 -0
  201. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/configuration.rst +0 -0
  202. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/document-status.rst +0 -0
  203. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/edit-locally.rst +0 -0
  204. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/extensions.rst +0 -0
  205. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  206. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/index.rst +0 -0
  207. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/migrate.rst +0 -0
  208. {documenteer-1.4.3 → documenteer-2.0.0}/docs/technotes/wide-content.rst +0 -0
  209. {documenteer-1.4.3 → documenteer-2.0.0}/licenses/astropy-helpers.txt +0 -0
  210. {documenteer-1.4.3 → documenteer-2.0.0}/licenses/sphinx-issue.txt +0 -0
  211. {documenteer-1.4.3 → documenteer-2.0.0}/licenses/sphinx.txt +0 -0
  212. {documenteer-1.4.3 → documenteer-2.0.0}/package-lock.json +0 -0
  213. {documenteer-1.4.3 → documenteer-2.0.0}/package.json +0 -0
  214. {documenteer-1.4.3 → documenteer-2.0.0}/postcss.config.js +0 -0
  215. {documenteer-1.4.3 → documenteer-2.0.0}/setup.cfg +0 -0
  216. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  217. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  218. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  219. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/_properties.scss +0 -0
  220. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  221. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  222. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  223. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  224. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  225. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  226. {documenteer-1.4.3 → documenteer-2.0.0}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  227. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/__init__.py +0 -0
  228. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/.gitignore +0 -0
  229. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  230. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  231. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/favicon.ico +0 -0
  232. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  233. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  234. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  235. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-favicon.svg +0 -0
  236. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-technote.css +0 -0
  237. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-technote.css.map +0 -0
  238. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  239. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  240. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  241. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  242. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/conf/__init__.py +0 -0
  243. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/ext/__init__.py +0 -0
  244. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/py.typed +0 -0
  245. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/services/__init__.py +0 -0
  246. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/__init__.py +0 -0
  247. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/latex.py +0 -0
  248. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  249. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  250. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  251. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  252. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  253. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  254. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  255. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  256. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/pydata/layout.html +0 -0
  257. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/.gitkeep +0 -0
  258. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  259. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  260. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  261. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  262. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  263. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer/version.py +0 -0
  264. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer.egg-info/dependency_links.txt +0 -0
  265. {documenteer-1.4.3 → documenteer-2.0.0}/src/documenteer.egg-info/top_level.txt +0 -0
  266. {documenteer-1.4.3/src/documenteer/stackdocs → documenteer-2.0.0/tests}/__init__.py +0 -0
  267. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/afw.doxygen.conf +0 -0
  268. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/authordb.yaml +0 -0
  269. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/doxygen.tag.zip +0 -0
  270. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  271. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  272. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  273. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  274. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  275. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/include/README.md +0 -0
  276. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_alpha/src/README.md +0 -0
  277. {documenteer-1.4.3 → documenteer-2.0.0}/tests/data/package_beta/doc/README.md +0 -0
  278. {documenteer-1.4.3 → documenteer-2.0.0}/tests/ext/__init__.py +0 -0
  279. {documenteer-1.4.3 → documenteer-2.0.0}/tests/roots/test-autocppapi/conf.py +0 -0
  280. {documenteer-1.4.3 → documenteer-2.0.0}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  281. {documenteer-1.4.3 → documenteer-2.0.0}/tests/roots/test-autocppapi/index.rst +0 -0
  282. {documenteer-1.4.3/tests/ext/lssttasks → documenteer-2.0.0/tests/services}/__init__.py +0 -0
  283. {documenteer-1.4.3/tests/services → documenteer-2.0.0/tests/storage}/__init__.py +0 -0
  284. {documenteer-1.4.3 → documenteer-2.0.0}/tests/test_conf_utils.py +0 -0
  285. {documenteer-1.4.3 → documenteer-2.0.0}/webpack.config.js +0 -0
@@ -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,5 +1,8 @@
1
1
  name: CI
2
2
 
3
+ env:
4
+ PYTHON_VERSION: '3.13' # Default Python version
5
+
3
6
  'on':
4
7
  push:
5
8
  branches-ignore:
@@ -24,7 +27,7 @@ jobs:
24
27
  - name: Set up Python
25
28
  uses: actions/setup-python@v5
26
29
  with:
27
- python-version: '3.12'
30
+ python-version: ${{ env.PYTHON_VERSION }}
28
31
 
29
32
  - uses: actions/setup-node@v4
30
33
  with:
@@ -45,8 +48,9 @@ jobs:
45
48
  - name: Run tox
46
49
  uses: lsst-sqre/run-tox@v1
47
50
  with:
48
- python-version: '3.12'
51
+ python-version: ${{ env.PYTHON_VERSION }}
49
52
  tox-envs: 'lint'
53
+ tox-plugins: tox-uv
50
54
 
51
55
  test:
52
56
  runs-on: ubuntu-latest
@@ -54,10 +58,11 @@ jobs:
54
58
  strategy:
55
59
  matrix:
56
60
  python-version:
57
- - '3.11'
58
61
  - '3.12'
62
+ - '3.13'
59
63
  sphinx-version:
60
64
  - '7'
65
+ - '8'
61
66
 
62
67
  steps:
63
68
  - uses: actions/checkout@v4
@@ -80,33 +85,49 @@ jobs:
80
85
  npm install
81
86
  npm run build
82
87
 
83
- - name: Install graphviz
84
- run: |
85
- sudo apt-get update
86
- sudo apt-get install graphviz
88
+ - name: Setup Graphviz
89
+ uses: ts-graphviz/setup-graphviz@v2
87
90
 
88
91
  - name: Run tox
89
92
  uses: lsst-sqre/run-tox@v1
90
93
  with:
91
94
  python-version: ${{ matrix.python-version }}
92
- tox-envs: 'lint,py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
95
+ tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
96
+ tox-plugins: tox-uv
93
97
 
94
98
  docs:
95
99
  runs-on: ubuntu-latest
96
100
 
97
101
  steps:
98
- - uses: actions/checkout@v3
102
+ - uses: actions/checkout@v4
99
103
  with:
100
104
  fetch-depth: 0 # full history for setuptools_scm
101
105
 
102
- - name: Install Graphviz
103
- 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
104
124
 
105
125
  - name: Run tox
106
126
  uses: lsst-sqre/run-tox@v1
107
127
  with:
108
- python-version: '3.12'
128
+ python-version: ${{ env.PYTHON_VERSION }}
109
129
  tox-envs: 'docs,docs-lint'
130
+ tox-plugins: tox-uv
110
131
 
111
132
  # Only attempt documentation uploads for tagged releases and pull
112
133
  # requests from ticket branches in the same repository. This avoids
@@ -122,7 +143,6 @@ jobs:
122
143
  if: >
123
144
  github.event_name != 'pull_request' || startsWith(github.head_ref, 'tickets/')
124
145
 
125
-
126
146
  test-package:
127
147
  name: Test PyPI package build
128
148
  runs-on: ubuntu-latest
@@ -132,11 +152,26 @@ jobs:
132
152
  with:
133
153
  fetch-depth: 0 # full history for setuptools_scm
134
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
+
135
171
  - name: Build and publish
136
- uses: lsst-sqre/build-and-publish-to-pypi@v2
172
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
137
173
  with:
138
- python-version: '3.12'
139
- upload: 'false'
174
+ upload: "false"
140
175
 
141
176
  pypi-publish:
142
177
  name: Upload release to PyPI
@@ -159,12 +194,16 @@ jobs:
159
194
  cache: 'npm'
160
195
  node-version-file: '.nvmrc'
161
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
+
162
203
  - name: npm install and build
163
204
  run: |
164
205
  npm install
165
206
  npm run build
166
207
 
167
208
  - name: Build and publish
168
- uses: lsst-sqre/build-and-publish-to-pypi@v2
169
- with:
170
- python-version: '3.12'
209
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
@@ -14,26 +14,16 @@ repos:
14
14
  - id: rst-linter
15
15
  files: (README\.rst)|(CHANGELOG\.rst)
16
16
 
17
- - repo: https://github.com/PyCQA/isort/
18
- rev: 5.13.2
17
+ - repo: https://github.com/astral-sh/ruff-pre-commit
18
+ rev: v0.6.1
19
19
  hooks:
20
- - id: isort
21
- additional_dependencies:
22
- - toml
20
+ - id: ruff
21
+ args: [--fix, --exit-non-zero-on-fix]
22
+ - id: ruff-format
23
23
 
24
- - repo: https://github.com/psf/black
25
- rev: 24.4.2
26
- hooks:
27
- - id: black
28
-
29
- - repo: https://github.com/asottile/blacken-docs
30
- rev: 1.16.0
24
+ - repo: https://github.com/adamchainz/blacken-docs
25
+ rev: 1.18.0
31
26
  hooks:
32
27
  - id: blacken-docs
33
- additional_dependencies: [black==22.12.0]
34
- args: [-l, '79', -t, py38]
35
-
36
- - repo: https://github.com/pycqa/flake8
37
- rev: 7.0.0
38
- hooks:
39
- - id: flake8
28
+ additional_dependencies: [black==24.4.2]
29
+ args: [-l, '79', -t, py312]
@@ -0,0 +1,4 @@
1
+ {
2
+ "[python]": {
3
+ }
4
+ }
@@ -2,6 +2,94 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-2.0.0'></a>
6
+ ## 2.0.0 (2025-07-10)
7
+
8
+ ### Backwards-incompatible changes
9
+
10
+ - All Science Pipelines-related tooling and Sphinx extensions have been removed from Documenteer and moved to a new Science Pipelines package called `sphinxutils` (https://github.com/lsst-dm/sphinxutils). Removed components include:
11
+
12
+ - `documenteer.stackdocs`
13
+ - Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
14
+ - CLI commands `stack-docs` and `package-docs`
15
+ - Sphinx extensions:
16
+ - `documenteer.ext.lssttasks`
17
+ - `documenteer.ext.packagetoctree`
18
+ - `documenteer.ext.autocppapi`
19
+ - `documenteer.ext.autodocreset`
20
+
21
+ - Dropped support for Python 3.11. Python 3.12 or later is now required.
22
+
23
+ - Removed `documenteer.requestutils`, `documenteer.packagemetadata`, and `documenteer.utils` from the public API.
24
+
25
+ ### New features
26
+
27
+ - User guide configuration improvements:
28
+
29
+ - New custom automodapi templates for Pydantic BaseModels and exceptions. The exception template ensures that inherited members of exceptions are documented. The Pydantic BaseModel template ensures that inherited members from the `BaseModel` class itself are _not_ documented. These templates were originally developed as part of [Gafaelfawr](https://github.com/lsst-sqre/gafaelfawr). Now users of the user guide configuration benefit from these templates without any additional configuration.
30
+
31
+ - The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
32
+
33
+ - The `documenteer.conf.guide` configuration now ignores common Sphinx warnings when including references to projects that don't use Sphinx/Intersphinx for their documentation, including Pydantic and FastAPI.
34
+
35
+ - Updated to pydata-sphinx-theme 0.16.
36
+
37
+ - Added [sphinx-favicon](https://sphinx-favicon.readthedocs.io/en/stable/index.html) for managing favicons in user guides.
38
+
39
+ - 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.
40
+
41
+ - 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.
42
+
43
+ - 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.
44
+
45
+ - The `documenteer` `add-authors` and `sync-authors` CLI commands now use the Ook web API to get author information, rather than directly reading `authordb.yaml` from lsst/lsst-texmf.
46
+
47
+ - The entire `documenteer` code base is now type annotated.
48
+
49
+ ### Bug fixes
50
+
51
+ - Updated `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with Sphinx 8.1.0 and allows unpinning the Mermaid JS version.
52
+
53
+ - Pinned Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
54
+
55
+ - Documenteer's Sphinx extensions now provide proper extension metadata to support version-based cache busting and parallel builds.
56
+
57
+ ### Other changes
58
+
59
+ - The code base is now linted and formatted with ruff.
60
+
61
+ - Added testing against Sphinx 8 and Python 3.13 in GitHub Actions.
62
+
63
+ - Updated the technote creation documentation to reference `@Squarebot`, updated from `sqrbot-jr`.
64
+
65
+ - Removed the pre-commit hook for prettier and now run prettier directly from the tox lint environment. This change is necessary because the prettier hook for pre-commit is no longer supported.
66
+
67
+ - Adopted [ts-graphviz/setup-graphviz](https://github.com/ts-graphviz/setup-graphviz) for installing Graphviz in GitHub Actions CI workflows.
68
+
69
+ - Updated how license information is encoded in `pyproject.toml`.
70
+
71
+ - Switched to dependency groups for development dependencies in `pyproject.toml`. With this change, Documenteer no longer publishes a `dev` extra to PyPI.
72
+
73
+ - Documenteer no longer depends on setuptools as a runtime dependency thanks to pybtex version 0.25 and `documenteer.ext.redoc`.
74
+
75
+ <a id='changelog-1.4.5'></a>
76
+ ## 1.4.5 (2025-06-25)
77
+
78
+ ### Other changes
79
+
80
+ - Update to lsst-sqre/build-and-publish-to-pypi@v3 for publishing to PyPI.
81
+
82
+ <a id='changelog-1.4.4'></a>
83
+ ## 1.4.4 (2025-06-25)
84
+
85
+ ### Bug fixes
86
+
87
+ - 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.
88
+
89
+ ### Other changes
90
+
91
+ - Add testing against Python 3.13 and Sphinx 8.
92
+
5
93
  <a id='changelog-1.4.3'></a>
6
94
  ## 1.4.3 (2025-02-19)
7
95
 
@@ -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
@@ -0,0 +1,97 @@
1
+ Metadata-Version: 2.4
2
+ Name: documenteer
3
+ Version: 2.0.0
4
+ Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
+ License-Expression: MIT
6
+ Project-URL: Homepage, https://documenteer.lsst.io
7
+ Project-URL: Source, https://github.com/lsst-sqre/documenteer
8
+ Keywords: rubin,lsst
9
+ Classifier: Development Status :: 5 - Production/Stable
10
+ Classifier: Environment :: Console
11
+ Classifier: Framework :: Sphinx :: Extension
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Natural Language :: English
14
+ Classifier: Operating System :: POSIX
15
+ Classifier: Programming Language :: Python
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Topic :: Documentation
20
+ Classifier: Topic :: Documentation :: Sphinx
21
+ Classifier: Typing :: Typed
22
+ Requires-Python: >=3.12
23
+ Description-Content-Type: text/markdown
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
30
+ Requires-Dist: docutils>=0.20
31
+ Requires-Dist: Sphinx<8.2,>=7
32
+ Requires-Dist: PyYAML
33
+ Requires-Dist: GitPython
34
+ Requires-Dist: requests
35
+ Requires-Dist: click
36
+ Requires-Dist: sphinxcontrib-bibtex>=2.6.5
37
+ Requires-Dist: pybtex>=0.25.0
38
+ Requires-Dist: pydantic>=2.0.0
39
+ Requires-Dist: urllib3
40
+ Requires-Dist: pylatexenc
41
+ Requires-Dist: tomlkit
42
+ Provides-Extra: guide
43
+ Requires-Dist: autodoc_pydantic; extra == "guide"
44
+ Requires-Dist: sphinx_design; extra == "guide"
45
+ Requires-Dist: pydata-sphinx-theme<0.17.0,>=0.16.1; extra == "guide"
46
+ Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
47
+ Requires-Dist: sphinx-automodapi; extra == "guide"
48
+ Requires-Dist: sphinx-copybutton; extra == "guide"
49
+ Requires-Dist: sphinx-prompt; extra == "guide"
50
+ Requires-Dist: sphinx-jinja>=2; extra == "guide"
51
+ Requires-Dist: myst-parser; extra == "guide"
52
+ Requires-Dist: myst-nb; extra == "guide"
53
+ Requires-Dist: markdown-it-py[linkify]; extra == "guide"
54
+ Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
55
+ Requires-Dist: sphinxext-opengraph; extra == "guide"
56
+ Requires-Dist: sphinxcontrib-jquery; extra == "guide"
57
+ Requires-Dist: sphinxext-rediraffe; extra == "guide"
58
+ Requires-Dist: sphinxcontrib-youtube; extra == "guide"
59
+ Requires-Dist: sphinx-favicon; extra == "guide"
60
+ Provides-Extra: technote
61
+ Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
62
+ Requires-Dist: sphinx-prompt; extra == "technote"
63
+ Requires-Dist: sphinxcontrib-mermaid>=1; extra == "technote"
64
+ Requires-Dist: sphinx-diagrams; extra == "technote"
65
+ Requires-Dist: sphinx_design; extra == "technote"
66
+ Requires-Dist: myst-nb; extra == "technote"
67
+ Requires-Dist: sphinxcontrib-youtube; extra == "technote"
68
+ Dynamic: license-file
69
+
70
+ [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
71
+ [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
72
+ [![For Python 3.12+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
73
+ [![MIT license](https://img.shields.io/pypi/l/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
74
+ [![CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
75
+ [![Weekly CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml)
76
+
77
+ # Documenteer
78
+
79
+ Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, including [user guides](https://documenteer.lsst.io/guides/index.html) and [technotes](https://developer.lsst.io/project-docs/technotes.html).
80
+
81
+ For more information about Documenteer, see the documentation at https://documenteer.lsst.io.
82
+
83
+ Browse the [lsst-doc-engineering](https://github.com/topics/lsst-doc-engineering) GitHub topic for more Rubin Observatory documentation engineering projects.
84
+
85
+ ## Quick installation:
86
+
87
+ For [user guides](https://documenteer.lsst.io/guides/index.html):
88
+
89
+ ```sh
90
+ pip install "documenteer[guide]"
91
+ ```
92
+
93
+ For [technical note projects](https://documenteer.lsst.io/technotes/index.html):
94
+
95
+ ```sh
96
+ pip install "documenteer[technote]"
97
+ ```
@@ -1,13 +1,13 @@
1
1
  [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
2
2
  [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
3
- [![For Python 3.7+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
3
+ [![For Python 3.12+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
4
4
  [![MIT license](https://img.shields.io/pypi/l/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
5
5
  [![CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
6
6
  [![Weekly CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml)
7
7
 
8
8
  # Documenteer
9
9
 
10
- Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, [user guides](https://documenteer.lsst.io/guides/index.html), [technotes](https://developer.lsst.io/project-docs/technotes.html) and EUPS-packaged stacks (such as the [LSST Science Pipelines](https://pipelines.lsst.io)).
10
+ Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, including [user guides](https://documenteer.lsst.io/guides/index.html) and [technotes](https://developer.lsst.io/project-docs/technotes.html).
11
11
 
12
12
  For more information about Documenteer, see the documentation at https://documenteer.lsst.io.
13
13
 
@@ -26,9 +26,3 @@ For [technical note projects](https://documenteer.lsst.io/technotes/index.html):
26
26
  ```sh
27
27
  pip install "documenteer[technote]"
28
28
  ```
29
-
30
- For the [stack projects](https://documenteer.lsst.io/pipelines/index.html) (such as the [LSST Science Pipelines](https://pipelines.lsst.io)):
31
-
32
- ```sh
33
- pip install "documenteer[pipelines]"
34
- ```
@@ -1,7 +1,6 @@
1
1
  # Makefile for Sphinx documentation
2
2
 
3
3
  # You can set these variables from the command line.
4
- # SPHINXOPTS = -n -W
5
4
  SPHINXOPTS = -n
6
5
  SPHINXBUILD = sphinx-build
7
6
  BUILDDIR = _build
@@ -27,7 +27,6 @@
27
27
  .. _TOML: https://toml.io/en/
28
28
  .. _`SQR-006`: https://sqr-006.lsst.io
29
29
  .. _`lsstDoxygen`: https://github.com/lsst/lsstDoxygen
30
- .. _`package-docs`: https://documenteer.lsst.io/pipelines/package-docs-cli.html
31
30
  .. _`pex_config`: https://github.com/lsst/pex_config
32
31
  .. _`pipe_base`: https://github.com/lsst/pipe_base
33
32
  .. _`pipe_supertask`: https://github.com/lsst/pipe_supertask
@@ -64,16 +63,12 @@
64
63
  .. _pipx: https://pipx.pypa.io
65
64
  .. _`LSSTC Slack Workspace`: https://lsstc.slack.com
66
65
 
67
- .. |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>`__
68
67
 
69
68
  .. Internal links
70
69
 
71
70
  .. |documenteer.toml| replace:: :doc:`documenteer.toml </guides/toml-reference>`
72
71
  .. |documenteer.conf.guide| replace:: :doc:`documenteer.conf.guide </guides/configuration-preset>`
73
- .. |package-docs| replace:: :doc:`package-docs </guides/pipelines/package-docs-cli>`
74
- .. |stack-docs| replace:: :doc:`stack-docs </guides/pipelines/stack-docs-cli>`
75
- .. |stack-docs-build| replace:: :doc:`stack-docs build </guides/pipelines/stack-docs-cli>`
76
- .. |stack-docs-clean| replace:: :doc:`stack-docs clean </guides/pipelines/stack-docs-cli>`
77
72
 
78
73
  .. links to sphinx directives
79
74