documenteer 1.4.3__tar.gz → 2.0.0a3__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 (270) hide show
  1. documenteer-2.0.0a3/.github/workflows/ci-cron.yaml +176 -0
  2. {documenteer-1.4.3 → documenteer-2.0.0a3}/.github/workflows/ci.yaml +13 -9
  3. {documenteer-1.4.3 → documenteer-2.0.0a3}/.pre-commit-config.yaml +9 -19
  4. documenteer-2.0.0a3/.vscode/settings.json +4 -0
  5. {documenteer-1.4.3 → documenteer-2.0.0a3}/CHANGELOG.md +0 -25
  6. {documenteer-1.4.3/src/documenteer.egg-info → documenteer-2.0.0a3}/PKG-INFO +11 -24
  7. documenteer-2.0.0a3/changelog.d/20240819_152413_jsick_DM_45803.md +33 -0
  8. documenteer-2.0.0a3/changelog.d/20241010_133336_danfuchs_mermaid_compat.md +4 -0
  9. documenteer-2.0.0a3/changelog.d/20250203_175511_jsick_DM_48755.md +3 -0
  10. documenteer-2.0.0a3/changelog.d/20250219_160628_jsick_DM_49037.md +19 -0
  11. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/Makefile +1 -2
  12. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/_rst_epilog.rst +1 -6
  13. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/changelog.md +0 -25
  14. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/api/documenteer.ext.rst +0 -7
  15. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/api/index.rst +0 -2
  16. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/documenteer.toml +10 -8
  17. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/index.rst +0 -8
  18. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/page-redirects.rst +1 -1
  19. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/index.rst +1 -15
  20. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/index.rst +0 -10
  21. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/edit-on-github.rst +1 -1
  22. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/start-a-technote.rst +1 -1
  23. {documenteer-1.4.3 → documenteer-2.0.0a3}/pyproject.toml +70 -40
  24. documenteer-2.0.0a3/ruff-shared.toml +139 -0
  25. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/cli.py +1 -2
  26. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/conf/_toml.py +45 -55
  27. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/conf/_utils.py +4 -7
  28. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/conf/guide.py +57 -16
  29. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/conf/technote.py +5 -11
  30. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/bibtex.py +4 -2
  31. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/githubbibcache.py +1 -1
  32. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/jira.py +49 -35
  33. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/lsstdocushare.py +17 -16
  34. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/mockcoderefs.py +16 -4
  35. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/openapi.py +6 -6
  36. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/remotecodeblock.py +25 -29
  37. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/packagemetadata.py +8 -22
  38. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/requestsutils.py +8 -7
  39. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/services/technoteauthor.py +6 -4
  40. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/services/technotemigration.py +21 -14
  41. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/authordb.py +2 -7
  42. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/conf.py +1 -1
  43. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates.py +1 -1
  44. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/technotetoml.py +3 -6
  45. documenteer-2.0.0a3/src/documenteer/templates/pydata/autosummary_core/exception.rst +15 -0
  46. documenteer-2.0.0a3/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +11 -0
  47. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/utils.py +11 -13
  48. {documenteer-1.4.3 → documenteer-2.0.0a3/src/documenteer.egg-info}/PKG-INFO +11 -24
  49. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer.egg-info/SOURCES.txt +8 -49
  50. documenteer-2.0.0a3/src/documenteer.egg-info/entry_points.txt +2 -0
  51. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer.egg-info/requires.txt +1 -18
  52. documenteer-2.0.0a3/tests/conftest.py +24 -0
  53. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/ext/jira_test.py +6 -5
  54. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/ext/lsstdocushare_test.py +7 -5
  55. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/ext/mockcoderefs_test.py +13 -11
  56. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/storage/technotetoml_test.py +0 -1
  57. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/test_conf_toml.py +3 -5
  58. {documenteer-1.4.3 → documenteer-2.0.0a3}/tox.ini +12 -6
  59. documenteer-1.4.3/.github/workflows/ci-cron.yaml +0 -98
  60. documenteer-1.4.3/.github/workflows/dependencies.yaml +0 -33
  61. documenteer-1.4.3/.vscode/settings.json +0 -6
  62. documenteer-1.4.3/docs/dev/api/documenteer.sphinxrunner.rst +0 -6
  63. documenteer-1.4.3/docs/dev/api/documenteer.stackdocs.rst +0 -21
  64. documenteer-1.4.3/docs/guides/pipelines/build-overview.rst +0 -112
  65. documenteer-1.4.3/docs/guides/pipelines/configuration.rst +0 -84
  66. documenteer-1.4.3/docs/guides/pipelines/cpp-api-linking.rst +0 -116
  67. documenteer-1.4.3/docs/guides/pipelines/index.rst +0 -17
  68. documenteer-1.4.3/docs/guides/pipelines/install.rst +0 -45
  69. documenteer-1.4.3/docs/guides/pipelines/package-docs-cli.rst +0 -15
  70. documenteer-1.4.3/docs/guides/pipelines/stack-docs-cli.rst +0 -15
  71. documenteer-1.4.3/docs/sphinx-extensions/autocppapi.rst +0 -69
  72. documenteer-1.4.3/docs/sphinx-extensions/autodocreset.rst +0 -22
  73. documenteer-1.4.3/docs/sphinx-extensions/lssttasks.rst +0 -376
  74. documenteer-1.4.3/docs/sphinx-extensions/package-toctree.rst +0 -76
  75. documenteer-1.4.3/src/documenteer/conf/pipelines.py +0 -224
  76. documenteer-1.4.3/src/documenteer/conf/pipelinespkg.py +0 -15
  77. documenteer-1.4.3/src/documenteer/ext/_utils.py +0 -210
  78. documenteer-1.4.3/src/documenteer/ext/autocppapi.py +0 -307
  79. documenteer-1.4.3/src/documenteer/ext/autodocreset.py +0 -26
  80. documenteer-1.4.3/src/documenteer/ext/lssttasks/__init__.py +0 -84
  81. documenteer-1.4.3/src/documenteer/ext/lssttasks/configfieldlists.py +0 -1179
  82. documenteer-1.4.3/src/documenteer/ext/lssttasks/crossrefs.py +0 -397
  83. documenteer-1.4.3/src/documenteer/ext/lssttasks/pyapisummary.py +0 -320
  84. documenteer-1.4.3/src/documenteer/ext/lssttasks/taskutils.py +0 -221
  85. documenteer-1.4.3/src/documenteer/ext/lssttasks/topiclists.py +0 -276
  86. documenteer-1.4.3/src/documenteer/ext/lssttasks/topics.py +0 -169
  87. documenteer-1.4.3/src/documenteer/ext/packagetoctree.py +0 -245
  88. documenteer-1.4.3/src/documenteer/sphinxrunner.py +0 -69
  89. documenteer-1.4.3/src/documenteer/stackdocs/build.py +0 -307
  90. documenteer-1.4.3/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -35489
  91. documenteer-1.4.3/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -2414
  92. documenteer-1.4.3/src/documenteer/stackdocs/data/mainpage.dox +0 -9
  93. documenteer-1.4.3/src/documenteer/stackdocs/doxygen.py +0 -732
  94. documenteer-1.4.3/src/documenteer/stackdocs/doxygentag.py +0 -59
  95. documenteer-1.4.3/src/documenteer/stackdocs/packagecli.py +0 -142
  96. documenteer-1.4.3/src/documenteer/stackdocs/pkgdiscovery.py +0 -308
  97. documenteer-1.4.3/src/documenteer/stackdocs/rootdiscovery.py +0 -118
  98. documenteer-1.4.3/src/documenteer/stackdocs/stackcli.py +0 -342
  99. documenteer-1.4.3/src/documenteer.egg-info/entry_points.txt +0 -4
  100. documenteer-1.4.3/tests/conftest.py +0 -21
  101. documenteer-1.4.3/tests/ext/autocppapi_test.py +0 -38
  102. documenteer-1.4.3/tests/ext/lssttasks/taskutils_test.py +0 -32
  103. documenteer-1.4.3/tests/ext/packagetoctree_test.py +0 -20
  104. documenteer-1.4.3/tests/ext/utils_test.py +0 -25
  105. documenteer-1.4.3/tests/storage/__init__.py +0 -0
  106. documenteer-1.4.3/tests/test_stackdocs_build.py +0 -77
  107. documenteer-1.4.3/tests/test_stackdocs_doxygen.py +0 -168
  108. documenteer-1.4.3/tests/test_stackdocs_doxygentag.py +0 -48
  109. documenteer-1.4.3/tests/test_stackdocs_pkgdiscovery.py +0 -65
  110. documenteer-1.4.3/tests/test_stackdocs_rootdiscovery.py +0 -117
  111. {documenteer-1.4.3 → documenteer-2.0.0a3}/.flake8 +0 -0
  112. {documenteer-1.4.3 → documenteer-2.0.0a3}/.github/CODE_OF_CONDUCT.md +0 -0
  113. {documenteer-1.4.3 → documenteer-2.0.0a3}/.github/CONTRIBUTING.md +0 -0
  114. {documenteer-1.4.3 → documenteer-2.0.0a3}/.github/SUPPORT.md +0 -0
  115. {documenteer-1.4.3 → documenteer-2.0.0a3}/.github/dependabot.yml +0 -0
  116. {documenteer-1.4.3 → documenteer-2.0.0a3}/.gitignore +0 -0
  117. {documenteer-1.4.3 → documenteer-2.0.0a3}/.npmrc +0 -0
  118. {documenteer-1.4.3 → documenteer-2.0.0a3}/.nvmrc +0 -0
  119. {documenteer-1.4.3 → documenteer-2.0.0a3}/.prettierignore +0 -0
  120. {documenteer-1.4.3 → documenteer-2.0.0a3}/.prettierrc.yaml +0 -0
  121. {documenteer-1.4.3 → documenteer-2.0.0a3}/.vscode/tasks.json +0 -0
  122. {documenteer-1.4.3 → documenteer-2.0.0a3}/LICENSE +0 -0
  123. {documenteer-1.4.3 → documenteer-2.0.0a3}/MANIFEST.in +0 -0
  124. {documenteer-1.4.3 → documenteer-2.0.0a3}/Makefile +0 -0
  125. {documenteer-1.4.3 → documenteer-2.0.0a3}/README.md +0 -0
  126. {documenteer-1.4.3 → documenteer-2.0.0a3}/changelog.d/_template.md.jinja +0 -0
  127. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/.gitignore +0 -0
  128. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/Makefile +0 -0
  129. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/conf.py +0 -0
  130. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/diagram.py +0 -0
  131. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
  132. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/index.ipynb +0 -0
  133. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
  134. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/ipynb-technote/technote.toml +0 -0
  135. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/.gitignore +0 -0
  136. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/Makefile +0 -0
  137. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/conf.py +0 -0
  138. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/diagram.py +0 -0
  139. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/index.md +0 -0
  140. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/md-technote/technote.toml +0 -0
  141. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/.gitignore +0 -0
  142. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/Makefile +0 -0
  143. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/conf.py +0 -0
  144. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/diagram.py +0 -0
  145. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/index.rst +0 -0
  146. {documenteer-1.4.3 → documenteer-2.0.0a3}/demo/rst-technote/technote.toml +0 -0
  147. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/.gitignore +0 -0
  148. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/conf.py +0 -0
  149. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/api/documenteer.conf.rst +0 -0
  150. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/api/documenteer.requestsutils.rst +0 -0
  151. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/development.rst +0 -0
  152. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/html-templates.rst +0 -0
  153. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/index.rst +0 -0
  154. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/release.rst +0 -0
  155. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/theme-assets.rst +0 -0
  156. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/dev/theme.rst +0 -0
  157. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/badges.rst +0 -0
  158. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/configuration-preset.rst +0 -0
  159. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/configuration.rst +0 -0
  160. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/diagrams.rst +0 -0
  161. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/extend-conf-py.rst +0 -0
  162. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/including-notebooks.ipynb +0 -0
  163. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/markdown-primer.md +0 -0
  164. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/openapi.rst +0 -0
  165. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/organization.rst +0 -0
  166. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/overview.rst +0 -0
  167. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/pyproject-configuration.rst +0 -0
  168. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/rst-epilog.rst +0 -0
  169. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/tabsets.rst +0 -0
  170. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/toml-reference.rst +0 -0
  171. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/guides/video-embeds.rst +0 -0
  172. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  173. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  174. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/jira-reference.rst +0 -0
  175. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  176. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/openapi.rst +0 -0
  177. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  178. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/_templates/README.md +0 -0
  179. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/_templates/README.rst +0 -0
  180. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/author-metadata.rst +0 -0
  181. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/configuration.rst +0 -0
  182. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/document-status.rst +0 -0
  183. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/edit-locally.rst +0 -0
  184. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/extensions.rst +0 -0
  185. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  186. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/index.rst +0 -0
  187. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/migrate.rst +0 -0
  188. {documenteer-1.4.3 → documenteer-2.0.0a3}/docs/technotes/wide-content.rst +0 -0
  189. {documenteer-1.4.3 → documenteer-2.0.0a3}/licenses/README.md +0 -0
  190. {documenteer-1.4.3 → documenteer-2.0.0a3}/licenses/astropy-helpers.txt +0 -0
  191. {documenteer-1.4.3 → documenteer-2.0.0a3}/licenses/sphinx-issue.txt +0 -0
  192. {documenteer-1.4.3 → documenteer-2.0.0a3}/licenses/sphinx.txt +0 -0
  193. {documenteer-1.4.3 → documenteer-2.0.0a3}/package-lock.json +0 -0
  194. {documenteer-1.4.3 → documenteer-2.0.0a3}/package.json +0 -0
  195. {documenteer-1.4.3 → documenteer-2.0.0a3}/postcss.config.js +0 -0
  196. {documenteer-1.4.3 → documenteer-2.0.0a3}/setup.cfg +0 -0
  197. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  198. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  199. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  200. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/_properties.scss +0 -0
  201. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  202. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  203. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  204. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  205. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  206. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  207. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  208. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/__init__.py +0 -0
  209. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/.gitignore +0 -0
  210. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  211. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  212. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/favicon.ico +0 -0
  213. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  214. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  215. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  216. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-favicon.svg +0 -0
  217. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-pydata-theme.css +0 -0
  218. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-technote.css +0 -0
  219. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-technote.css.map +0 -0
  220. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  221. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  222. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  223. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  224. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/conf/__init__.py +0 -0
  225. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/ext/__init__.py +0 -0
  226. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/py.typed +0 -0
  227. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/services/__init__.py +0 -0
  228. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/__init__.py +0 -0
  229. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/latex.py +0 -0
  230. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  231. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  232. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  233. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  234. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  235. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  236. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  237. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  238. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/pydata/layout.html +0 -0
  239. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/.gitkeep +0 -0
  240. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  241. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  242. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  243. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  244. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  245. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer/version.py +0 -0
  246. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer.egg-info/dependency_links.txt +0 -0
  247. {documenteer-1.4.3 → documenteer-2.0.0a3}/src/documenteer.egg-info/top_level.txt +0 -0
  248. {documenteer-1.4.3/src/documenteer/stackdocs → documenteer-2.0.0a3/tests}/__init__.py +0 -0
  249. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/afw.doxygen.conf +0 -0
  250. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/authordb.yaml +0 -0
  251. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/doxygen.tag.zip +0 -0
  252. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  253. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  254. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  255. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  256. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  257. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/include/README.md +0 -0
  258. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_alpha/src/README.md +0 -0
  259. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/data/package_beta/doc/README.md +0 -0
  260. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/ext/__init__.py +0 -0
  261. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/packagemetadata_test.py +0 -0
  262. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/conf.py +0 -0
  263. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  264. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/index.rst +0 -0
  265. {documenteer-1.4.3/tests/ext/lssttasks → documenteer-2.0.0a3/tests/services}/__init__.py +0 -0
  266. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/services/technotemigration_test.py +0 -0
  267. {documenteer-1.4.3/tests/services → documenteer-2.0.0a3/tests/storage}/__init__.py +0 -0
  268. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/storage/authordb_test.py +0 -0
  269. {documenteer-1.4.3 → documenteer-2.0.0a3}/tests/test_conf_utils.py +0 -0
  270. {documenteer-1.4.3 → documenteer-2.0.0a3}/webpack.config.js +0 -0
@@ -0,0 +1,176 @@
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.12"
9
+
10
+ "on":
11
+ schedule:
12
+ - cron: "0 12 * * 1"
13
+
14
+ jobs:
15
+ lint:
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+
20
+ - name: Set up Python
21
+ uses: actions/setup-python@v5
22
+ with:
23
+ python-version: ${{ env.PYTHON_VERSION }}
24
+
25
+ - uses: actions/setup-node@v4
26
+ with:
27
+ cache: 'npm'
28
+ node-version-file: '.nvmrc'
29
+
30
+ - name: Authenticate GitHub Packages
31
+ run: |
32
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
33
+ env:
34
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35
+
36
+ - name: npm install and build
37
+ run: |
38
+ npm install
39
+ npm run build
40
+
41
+ - name: Run tox
42
+ uses: lsst-sqre/run-tox@v1
43
+ with:
44
+ python-version: ${{ env.PYTHON_VERSION }}
45
+ tox-envs: 'lint'
46
+ use-cache: false
47
+
48
+ - name: Report status
49
+ if: failure()
50
+ uses: ravsamhq/notify-slack-action@v2
51
+ with:
52
+ status: ${{ job.status }}
53
+ notify_when: "failure"
54
+ notification_title: "Periodic lint for {repo} failed"
55
+ env:
56
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
57
+
58
+ test:
59
+ runs-on: ubuntu-latest
60
+
61
+ strategy:
62
+ matrix:
63
+ python-version:
64
+ - "3.11"
65
+ - "3.12"
66
+ - "3.13"
67
+ sphinx-version:
68
+ - "7"
69
+ - "8"
70
+ - "dev"
71
+
72
+ steps:
73
+ - uses: actions/checkout@v4
74
+ with:
75
+ fetch-depth: 0 # full history for setuptools_scm
76
+
77
+ - uses: actions/setup-node@v4
78
+ with:
79
+ node-version-file: '.nvmrc'
80
+
81
+ - name: Authenticate GitHub Packages
82
+ run: |
83
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
84
+ env:
85
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
86
+
87
+ - name: npm install and build
88
+ run: |
89
+ npm install
90
+ npm run build
91
+
92
+ - name: Install graphviz
93
+ run: |
94
+ sudo apt-get update
95
+ sudo apt-get install graphviz
96
+
97
+ - name: Run tests in tox
98
+ uses: lsst-sqre/run-tox@v1
99
+ with:
100
+ python-version: ${{ matrix.python-version }}
101
+ tox-envs: "typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
102
+ use-cache: false
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
+ - name: Build docs in tox
123
+ uses: lsst-sqre/run-tox@v1
124
+ with:
125
+ python-version: ${{ env.PYTHON_VERSION }}
126
+ tox-envs: "docs,docs-lint"
127
+ use-cache: false
128
+
129
+ - name: Report status
130
+ if: failure()
131
+ uses: ravsamhq/notify-slack-action@v2
132
+ with:
133
+ status: ${{ job.status }}
134
+ notify_when: "failure"
135
+ notification_title: "Periodic documentation test for {repo} failed"
136
+ env:
137
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
138
+
139
+ pypi:
140
+ runs-on: ubuntu-latest
141
+
142
+ steps:
143
+ - uses: actions/checkout@v4
144
+ with:
145
+ fetch-depth: 0 # full history for setuptools_scm
146
+
147
+ - uses: actions/setup-node@v4
148
+ with:
149
+ node-version-file: '.nvmrc'
150
+
151
+ - name: Authenticate GitHub Packages
152
+ run: |
153
+ echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
154
+ env:
155
+ NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
156
+
157
+ - name: npm install and build
158
+ run: |
159
+ npm install
160
+ npm run build
161
+
162
+ - name: Build and publish
163
+ uses: lsst-sqre/build-and-publish-to-pypi@v2
164
+ with:
165
+ python-version: ${{ env.PYTHON_VERSION }}
166
+ upload: false
167
+
168
+ - name: Report status
169
+ if: failure()
170
+ uses: ravsamhq/notify-slack-action@v2
171
+ with:
172
+ status: ${{ job.status }}
173
+ notify_when: "failure"
174
+ notification_title: "Periodic packaging test for {repo} failed"
175
+ env:
176
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
@@ -1,5 +1,8 @@
1
1
  name: CI
2
2
 
3
+ env:
4
+ PYTHON_VERSION: '3.12' # 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,7 +48,7 @@ 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'
50
53
 
51
54
  test:
@@ -56,8 +59,10 @@ jobs:
56
59
  python-version:
57
60
  - '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
@@ -89,13 +94,13 @@ jobs:
89
94
  uses: lsst-sqre/run-tox@v1
90
95
  with:
91
96
  python-version: ${{ matrix.python-version }}
92
- tox-envs: 'lint,py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
97
+ tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
93
98
 
94
99
  docs:
95
100
  runs-on: ubuntu-latest
96
101
 
97
102
  steps:
98
- - uses: actions/checkout@v3
103
+ - uses: actions/checkout@v4
99
104
  with:
100
105
  fetch-depth: 0 # full history for setuptools_scm
101
106
 
@@ -105,7 +110,7 @@ jobs:
105
110
  - name: Run tox
106
111
  uses: lsst-sqre/run-tox@v1
107
112
  with:
108
- python-version: '3.12'
113
+ python-version: ${{ env.PYTHON_VERSION }}
109
114
  tox-envs: 'docs,docs-lint'
110
115
 
111
116
  # Only attempt documentation uploads for tagged releases and pull
@@ -122,7 +127,6 @@ jobs:
122
127
  if: >
123
128
  github.event_name != 'pull_request' || startsWith(github.head_ref, 'tickets/')
124
129
 
125
-
126
130
  test-package:
127
131
  name: Test PyPI package build
128
132
  runs-on: ubuntu-latest
@@ -135,8 +139,8 @@ jobs:
135
139
  - name: Build and publish
136
140
  uses: lsst-sqre/build-and-publish-to-pypi@v2
137
141
  with:
138
- python-version: '3.12'
139
- upload: 'false'
142
+ python-version: ${{ env.PYTHON_VERSION }}
143
+ upload: "false"
140
144
 
141
145
  pypi-publish:
142
146
  name: Upload release to PyPI
@@ -167,4 +171,4 @@ jobs:
167
171
  - name: Build and publish
168
172
  uses: lsst-sqre/build-and-publish-to-pypi@v2
169
173
  with:
170
- python-version: '3.12'
174
+ python-version: ${{ env.PYTHON_VERSION }}
@@ -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,31 +2,6 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
- <a id='changelog-1.4.3'></a>
6
- ## 1.4.3 (2025-02-19)
7
-
8
- ### Bug fixes
9
-
10
- - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
11
-
12
- ### Other changes
13
-
14
- - Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
15
-
16
- <a id='changelog-1.4.2'></a>
17
- ## 1.4.2 (2024-10-15)
18
-
19
- ### Bug fixes
20
-
21
- - Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
22
-
23
- <a id='changelog-1.4.1'></a>
24
- ## 1.4.1 (2024-10-10)
25
-
26
- ### Bug fixes
27
-
28
- - Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
29
-
30
5
  <a id='changelog-1.4.0'></a>
31
6
  ## 1.4.0 (2024-07-11)
32
7
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: documenteer
3
- Version: 1.4.3
3
+ Version: 2.0.0a3
4
4
  Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
5
  License: The MIT License (MIT)
6
6
 
@@ -27,18 +27,21 @@ License: The MIT License (MIT)
27
27
  Project-URL: Homepage, https://documenteer.lsst.io
28
28
  Project-URL: Source, https://github.com/lsst-sqre/documenteer
29
29
  Keywords: rubin,lsst
30
- Classifier: Development Status :: 4 - Beta
30
+ Classifier: Development Status :: 5 - Production/Stable
31
+ Classifier: Environment :: Console
32
+ Classifier: Framework :: Sphinx :: Extension
33
+ Classifier: Intended Audience :: Developers
31
34
  Classifier: License :: OSI Approved :: MIT License
35
+ Classifier: Natural Language :: English
36
+ Classifier: Operating System :: POSIX
32
37
  Classifier: Programming Language :: Python
33
38
  Classifier: Programming Language :: Python :: 3
34
39
  Classifier: Programming Language :: Python :: 3.11
35
- Classifier: Intended Audience :: Developers
40
+ Classifier: Programming Language :: Python :: 3.12
41
+ Classifier: Programming Language :: Python :: 3.13
36
42
  Classifier: Topic :: Documentation
37
43
  Classifier: Topic :: Documentation :: Sphinx
38
- Classifier: Framework :: Sphinx :: Extension
39
- Classifier: Environment :: Console
40
- Classifier: Natural Language :: English
41
- Classifier: Operating System :: POSIX
44
+ Classifier: Typing :: Typed
42
45
  Requires-Python: >=3.11
43
46
  Description-Content-Type: text/markdown
44
47
  License-File: LICENSE
@@ -70,6 +73,7 @@ Requires-Dist: types-PyYAML; extra == "dev"
70
73
  Requires-Dist: types-docutils; extra == "dev"
71
74
  Requires-Dist: types-mock; extra == "dev"
72
75
  Provides-Extra: guide
76
+ Requires-Dist: autodoc_pydantic; extra == "guide"
73
77
  Requires-Dist: sphinx_design; extra == "guide"
74
78
  Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
75
79
  Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
@@ -86,23 +90,6 @@ Requires-Dist: sphinxcontrib-redoc; extra == "guide"
86
90
  Requires-Dist: sphinxcontrib-jquery; extra == "guide"
87
91
  Requires-Dist: sphinxext-rediraffe; extra == "guide"
88
92
  Requires-Dist: sphinxcontrib-youtube; extra == "guide"
89
- Provides-Extra: pipelines
90
- Requires-Dist: sphinx_design; extra == "pipelines"
91
- Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
92
- Requires-Dist: sphinx-autodoc-typehints; extra == "pipelines"
93
- Requires-Dist: sphinx-automodapi; extra == "pipelines"
94
- Requires-Dist: sphinx-copybutton; extra == "pipelines"
95
- Requires-Dist: sphinx-prompt; extra == "pipelines"
96
- Requires-Dist: sphinx-jinja>=2; extra == "pipelines"
97
- Requires-Dist: myst-parser; extra == "pipelines"
98
- Requires-Dist: markdown-it-py[linkify]; extra == "pipelines"
99
- Requires-Dist: sphinxcontrib-mermaid; extra == "pipelines"
100
- Requires-Dist: sphinxext-opengraph; extra == "pipelines"
101
- Requires-Dist: sphinxcontrib-redoc; extra == "pipelines"
102
- Requires-Dist: sphinxcontrib-jquery; extra == "pipelines"
103
- Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
104
- Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
105
- Requires-Dist: sphinx-click; extra == "pipelines"
106
93
  Provides-Extra: technote
107
94
  Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
108
95
  Requires-Dist: sphinx-prompt; extra == "technote"
@@ -0,0 +1,33 @@
1
+ ### Backwards-incompatible changes
2
+
3
+ - All Science Pipelines-related tooling and Sphinx extensions have been removed from Documenteer, and can now be found in a new Science Pipelines package called `sphinxutils` (https://github.com/lsst-dm/sphinxutils). Specific removals include:
4
+
5
+ - `documenteer.stackdocs`
6
+ - Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
7
+ - CLI commands `stack-docs` and `package-docs`
8
+ - Sphinx extensions:
9
+ - `documenteer.ext.lssttasks`
10
+ - `documenteer.ext.packagetoctree`
11
+ - `documenteer.ext.autocppapi`
12
+ - `documenteer.ext.autodocreset`
13
+
14
+ ### New features
15
+
16
+ - User guide configuration improvements:
17
+
18
+ - 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.
19
+
20
+ - The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
21
+
22
+ - The `documenteer.conf.guide` configuration now ignores common Sphinx warnings that are common when including references to projects that don't use Sphinx/Intersphinx for this documentation, including Pydantic and FastAPI.
23
+
24
+ - The entire `documenteer` code base is now type annotated.
25
+
26
+ ### Bug fixes
27
+
28
+ -
29
+
30
+ ### Other changes
31
+
32
+ - The code base is now linted and formatted with ruff.
33
+ - Start testing against Sphinx 8.
@@ -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.
@@ -1,8 +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
5
- SPHINXOPTS = -n
4
+ SPHINXOPTS = -n -W
6
5
  SPHINXBUILD = sphinx-build
7
6
  BUILDDIR = _build
8
7
 
@@ -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
 
@@ -2,31 +2,6 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
- <a id='changelog-1.4.3'></a>
6
- ## 1.4.3 (2025-02-19)
7
-
8
- ### Bug fixes
9
-
10
- - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
11
-
12
- ### Other changes
13
-
14
- - Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
15
-
16
- <a id='changelog-1.4.2'></a>
17
- ## 1.4.2 (2024-10-15)
18
-
19
- ### Bug fixes
20
-
21
- - Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
22
-
23
- <a id='changelog-1.4.1'></a>
24
- ## 1.4.1 (2024-10-10)
25
-
26
- ### Bug fixes
27
-
28
- - Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
29
-
30
5
  <a id='changelog-1.4.0'></a>
31
6
  ## 1.4.0 (2024-07-11)
32
7
 
@@ -2,10 +2,6 @@
2
2
  documenteer.ext
3
3
  ###############
4
4
 
5
- .. automodapi:: documenteer.ext.autocppapi
6
-
7
- .. automodapi:: documenteer.ext.autodocreset
8
-
9
5
  .. automodapi:: documenteer.ext.openapi
10
6
 
11
7
  .. automodapi:: documenteer.ext.bibtex
@@ -20,6 +16,3 @@ documenteer.ext
20
16
 
21
17
  .. automodapi:: documenteer.ext.mockcoderefs
22
18
  :no-inheritance-diagram:
23
-
24
- .. automodapi:: documenteer.ext.packagetoctree
25
- :no-inheritance-diagram:
@@ -8,5 +8,3 @@ Python API
8
8
  documenteer.conf
9
9
  documenteer.ext
10
10
  documenteer.requestsutils
11
- documenteer.sphinxrunner
12
- documenteer.stackdocs
@@ -11,6 +11,7 @@ package = "documenteer"
11
11
  extensions = [
12
12
  "sphinx_click.ext",
13
13
  "sphinxcontrib.autoprogram",
14
+ "sphinxcontrib.autodoc_pydantic"
14
15
  ]
15
16
  disable_primary_sidebars = ["index", "changelog"]
16
17
  rst_epilog_file = "_rst_epilog.rst"
@@ -25,7 +26,8 @@ nitpick_ignore_regex = [
25
26
  ]
26
27
  python_api_dir = "dev/api/contents"
27
28
  exclude = [
28
- "technotes/_templates/*"
29
+ "technotes/_templates/*",
30
+ "_templates/**"
29
31
  ]
30
32
 
31
33
  [sphinx.theme]
@@ -46,10 +48,10 @@ ignore = [
46
48
  ]
47
49
 
48
50
  [sphinx.redirects]
49
- "pipelines/build-overview.rst" = "guides/pipelines/build-overview.rst"
50
- "pipelines/configuration.rst" = "guides/pipelines/configuration.rst"
51
- "pipelines/cpp-api-linking.rst" = "guides/pipelines/cpp-api-linking.rst"
52
- "pipelines/index.rst" = "guides/pipelines/index.rst"
53
- "pipelines/install.rst" = "guides/pipelines/install.rst"
54
- "pipelines/package-docs-cli.rst" = "guides/pipelines/package-docs-cli.rst"
55
- "pipelines/stack-docs-cli.rst" = "guides/pipelines/stack-docs-cli.rst"
51
+ "pipelines/build-overview.rst" = "guides/index.rst"
52
+ "pipelines/configuration.rst" = "guides/index.rst"
53
+ "pipelines/cpp-api-linking.rst" = "guides/index.rst"
54
+ "pipelines/index.rst" = "guides/index.rst"
55
+ "pipelines/install.rst" = "guides/index.rst"
56
+ "pipelines/package-docs-cli.rst" = "guides/index.rst"
57
+ "pipelines/stack-docs-cli.rst" = "guides/index.rst"
@@ -47,14 +47,6 @@ Documenteer provides a configuration profile for creating branded user guides wi
47
47
  markdown-primer
48
48
  including-notebooks
49
49
 
50
- .. toctree::
51
- :maxdepth: 2
52
- :caption: Science Pipelines
53
- :name: toc-guides-pipelines
54
- :titlesonly:
55
-
56
- pipelines/index
57
-
58
50
  .. toctree::
59
51
  :maxdepth: 2
60
52
  :caption: Reference
@@ -23,7 +23,7 @@ These paths are relative to the documentation project's root directory (where :f
23
23
  The table accepts an arbitrary number of redirects:
24
24
 
25
25
  .. code-block:: toml
26
- :captin: documenteer.toml
26
+ :caption: documenteer.toml
27
27
 
28
28
  [sphinx.redirects]
29
29
  "old-page.rst" = "some-dir/new-page.rst"
@@ -42,14 +42,6 @@ Installation
42
42
 
43
43
  pip install "documenteer[technote]"
44
44
 
45
- For :doc:`LSST Science Pipelines projects and other EUPS stacks </guides/pipelines/index>`:
46
-
47
- .. code-block:: sh
48
-
49
- pip install "documenteer[pipelines]"
50
-
51
- See :doc:`/guides/pipelines/install` for more information.
52
-
53
45
  .. tab-item:: conda
54
46
 
55
47
  Documenteer is available from `conda-forge`_ for Conda_ users.
@@ -74,17 +66,11 @@ Installation
74
66
 
75
67
  conda-install lsst-documenteer-technote
76
68
 
77
- To install Documenteer for LSST Stack projects (such as https://pipelines.lsst.io and EUPS packages):
78
-
79
- .. code-block:: sh
80
-
81
- conda-install lsst-documenteer-pipelines
82
-
83
69
  Project guides
84
70
  ==============
85
71
 
86
72
  Documenteer provides centralized Sphinx configuration and support for Rubin Observatory documentation projects.
87
- This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides, to LSST Science Pipelines package documentation.
73
+ This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides.
88
74
 
89
75
  .. toctree::
90
76
  :maxdepth: 2
@@ -19,13 +19,3 @@ Sphinx extensions
19
19
 
20
20
  remote-code-block
21
21
  openapi
22
- autodocreset
23
-
24
- .. toctree::
25
- :maxdepth: 2
26
- :titlesonly:
27
- :caption: Science Pipelines
28
-
29
- lssttasks
30
- autocppapi
31
- package-toctree