documenteer 2.0.0a3__tar.gz → 2.1.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 (243) hide show
  1. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/workflows/ci-cron.yaml +27 -8
  2. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/workflows/ci.yaml +48 -13
  3. {documenteer-2.0.0a3 → documenteer-2.1.0}/CHANGELOG.md +130 -0
  4. documenteer-2.1.0/Makefile +25 -0
  5. {documenteer-2.0.0a3 → documenteer-2.1.0}/PKG-INFO +19 -55
  6. {documenteer-2.0.0a3 → documenteer-2.1.0}/README.md +2 -8
  7. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/Makefile +1 -1
  8. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/changelog.md +130 -0
  9. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/api/index.rst +0 -1
  10. documenteer-2.1.0/licenses/README.md +9 -0
  11. documenteer-2.1.0/licenses/sphinxcontrib-redoc.txt +23 -0
  12. {documenteer-2.0.0a3 → documenteer-2.1.0}/pyproject.toml +48 -35
  13. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-pydata-theme.css +16 -9
  14. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/cli.py +12 -9
  15. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/conf/_utils.py +73 -5
  16. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/conf/guide.py +68 -65
  17. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/conf/technote.py +31 -0
  18. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/bibtex.py +10 -1
  19. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/githubbibcache.py +3 -2
  20. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/jira.py +12 -4
  21. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/lsstdocushare.py +10 -1
  22. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/mockcoderefs.py +12 -4
  23. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/openapi.py +3 -2
  24. documenteer-2.1.0/src/documenteer/ext/redoc/__init__.py +5 -0
  25. documenteer-2.1.0/src/documenteer/ext/redoc/_redoc.py +135 -0
  26. documenteer-2.1.0/src/documenteer/ext/redoc/assets/redoc.html.jinja2 +36 -0
  27. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/remotecodeblock.py +5 -3
  28. documenteer-2.1.0/src/documenteer/ext/robots.py +112 -0
  29. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/services/technoteauthor.py +7 -17
  30. documenteer-2.1.0/src/documenteer/storage/authordb.py +102 -0
  31. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/technotetoml.py +12 -12
  32. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/pydata/layout.html +7 -1
  33. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/PKG-INFO +19 -55
  34. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/SOURCES.txt +22 -8
  35. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/requires.txt +7 -21
  36. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/conftest.py +0 -6
  37. documenteer-2.1.0/tests/ext/redoc_test.py +88 -0
  38. documenteer-2.1.0/tests/ext/robots_test.py +44 -0
  39. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/packagemetadata_test.py +1 -1
  40. documenteer-2.1.0/tests/roots/test-redoc/_static/openapi.json +1 -0
  41. documenteer-2.1.0/tests/roots/test-redoc/api.rst +5 -0
  42. documenteer-2.1.0/tests/roots/test-redoc/conf.py +1 -0
  43. documenteer-2.1.0/tests/roots/test-redoc/documenteer.toml +10 -0
  44. documenteer-2.1.0/tests/roots/test-redoc/index.rst +8 -0
  45. documenteer-2.1.0/tests/roots/test-robots-nositemap/conf.py +11 -0
  46. documenteer-2.1.0/tests/roots/test-robots-nositemap/index.rst +10 -0
  47. documenteer-2.1.0/tests/roots/test-robots-nositemap/page1.rst +5 -0
  48. documenteer-2.1.0/tests/roots/test-robots-sitemap/conf.py +12 -0
  49. documenteer-2.1.0/tests/roots/test-robots-sitemap/index.rst +11 -0
  50. documenteer-2.1.0/tests/roots/test-robots-sitemap/page1.rst +5 -0
  51. documenteer-2.1.0/tests/roots/test-robots-sitemap/page2.rst +5 -0
  52. documenteer-2.1.0/tests/services/technotemigration_test.py +104 -0
  53. documenteer-2.1.0/tests/storage/authordb_test.py +64 -0
  54. documenteer-2.1.0/tests/storage/technotetoml_test.py +125 -0
  55. {documenteer-2.0.0a3 → documenteer-2.1.0}/tox.ini +12 -5
  56. documenteer-2.0.0a3/Makefile +0 -18
  57. documenteer-2.0.0a3/changelog.d/20240819_152413_jsick_DM_45803.md +0 -33
  58. documenteer-2.0.0a3/changelog.d/20241010_133336_danfuchs_mermaid_compat.md +0 -4
  59. documenteer-2.0.0a3/changelog.d/20250203_175511_jsick_DM_48755.md +0 -3
  60. documenteer-2.0.0a3/changelog.d/20250219_160628_jsick_DM_49037.md +0 -19
  61. documenteer-2.0.0a3/docs/dev/api/documenteer.requestsutils.rst +0 -6
  62. documenteer-2.0.0a3/licenses/README.md +0 -4
  63. documenteer-2.0.0a3/src/documenteer/storage/authordb.py +0 -168
  64. documenteer-2.0.0a3/tests/services/technotemigration_test.py +0 -73
  65. documenteer-2.0.0a3/tests/storage/authordb_test.py +0 -34
  66. documenteer-2.0.0a3/tests/storage/technotetoml_test.py +0 -59
  67. {documenteer-2.0.0a3 → documenteer-2.1.0}/.flake8 +0 -0
  68. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/CODE_OF_CONDUCT.md +0 -0
  69. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/CONTRIBUTING.md +0 -0
  70. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/SUPPORT.md +0 -0
  71. {documenteer-2.0.0a3 → documenteer-2.1.0}/.github/dependabot.yml +0 -0
  72. {documenteer-2.0.0a3 → documenteer-2.1.0}/.gitignore +0 -0
  73. {documenteer-2.0.0a3 → documenteer-2.1.0}/.npmrc +0 -0
  74. {documenteer-2.0.0a3 → documenteer-2.1.0}/.nvmrc +0 -0
  75. {documenteer-2.0.0a3 → documenteer-2.1.0}/.pre-commit-config.yaml +0 -0
  76. {documenteer-2.0.0a3 → documenteer-2.1.0}/.prettierignore +0 -0
  77. {documenteer-2.0.0a3 → documenteer-2.1.0}/.prettierrc.yaml +0 -0
  78. {documenteer-2.0.0a3 → documenteer-2.1.0}/.vscode/settings.json +0 -0
  79. {documenteer-2.0.0a3 → documenteer-2.1.0}/.vscode/tasks.json +0 -0
  80. {documenteer-2.0.0a3 → documenteer-2.1.0}/LICENSE +0 -0
  81. {documenteer-2.0.0a3 → documenteer-2.1.0}/MANIFEST.in +0 -0
  82. {documenteer-2.0.0a3 → documenteer-2.1.0}/changelog.d/_template.md.jinja +0 -0
  83. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/.gitignore +0 -0
  84. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/Makefile +0 -0
  85. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/conf.py +0 -0
  86. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/diagram.py +0 -0
  87. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
  88. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/index.ipynb +0 -0
  89. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
  90. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/ipynb-technote/technote.toml +0 -0
  91. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/.gitignore +0 -0
  92. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/Makefile +0 -0
  93. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/conf.py +0 -0
  94. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/diagram.py +0 -0
  95. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/index.md +0 -0
  96. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/md-technote/technote.toml +0 -0
  97. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/.gitignore +0 -0
  98. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/Makefile +0 -0
  99. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/conf.py +0 -0
  100. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/diagram.py +0 -0
  101. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/index.rst +0 -0
  102. {documenteer-2.0.0a3 → documenteer-2.1.0}/demo/rst-technote/technote.toml +0 -0
  103. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/.gitignore +0 -0
  104. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/_rst_epilog.rst +0 -0
  105. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/conf.py +0 -0
  106. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/api/documenteer.conf.rst +0 -0
  107. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/api/documenteer.ext.rst +0 -0
  108. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/development.rst +0 -0
  109. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/html-templates.rst +0 -0
  110. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/index.rst +0 -0
  111. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/release.rst +0 -0
  112. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/theme-assets.rst +0 -0
  113. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/dev/theme.rst +0 -0
  114. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/documenteer.toml +0 -0
  115. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/badges.rst +0 -0
  116. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/configuration-preset.rst +0 -0
  117. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/configuration.rst +0 -0
  118. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/diagrams.rst +0 -0
  119. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/extend-conf-py.rst +0 -0
  120. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/including-notebooks.ipynb +0 -0
  121. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/index.rst +0 -0
  122. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/markdown-primer.md +0 -0
  123. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/openapi.rst +0 -0
  124. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/organization.rst +0 -0
  125. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/overview.rst +0 -0
  126. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/page-redirects.rst +0 -0
  127. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/pyproject-configuration.rst +0 -0
  128. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/rst-epilog.rst +0 -0
  129. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/tabsets.rst +0 -0
  130. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/toml-reference.rst +0 -0
  131. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/guides/video-embeds.rst +0 -0
  132. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/index.rst +0 -0
  133. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/docushare-reference.rst +0 -0
  134. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/githubbibcache.rst +0 -0
  135. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/index.rst +0 -0
  136. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/jira-reference.rst +0 -0
  137. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
  138. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/openapi.rst +0 -0
  139. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/sphinx-extensions/remote-code-block.rst +0 -0
  140. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/_templates/README.md +0 -0
  141. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/_templates/README.rst +0 -0
  142. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/author-metadata.rst +0 -0
  143. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/configuration.rst +0 -0
  144. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/document-status.rst +0 -0
  145. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/edit-locally.rst +0 -0
  146. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/edit-on-github.rst +0 -0
  147. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/extensions.rst +0 -0
  148. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/how-your-technote-gets-published.rst +0 -0
  149. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/index.rst +0 -0
  150. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/migrate.rst +0 -0
  151. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/start-a-technote.rst +0 -0
  152. {documenteer-2.0.0a3 → documenteer-2.1.0}/docs/technotes/wide-content.rst +0 -0
  153. {documenteer-2.0.0a3 → documenteer-2.1.0}/licenses/astropy-helpers.txt +0 -0
  154. {documenteer-2.0.0a3 → documenteer-2.1.0}/licenses/sphinx-issue.txt +0 -0
  155. {documenteer-2.0.0a3 → documenteer-2.1.0}/licenses/sphinx.txt +0 -0
  156. {documenteer-2.0.0a3 → documenteer-2.1.0}/package-lock.json +0 -0
  157. {documenteer-2.0.0a3 → documenteer-2.1.0}/package.json +0 -0
  158. {documenteer-2.0.0a3 → documenteer-2.1.0}/postcss.config.js +0 -0
  159. {documenteer-2.0.0a3 → documenteer-2.1.0}/ruff-shared.toml +0 -0
  160. {documenteer-2.0.0a3 → documenteer-2.1.0}/setup.cfg +0 -0
  161. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
  162. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
  163. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
  164. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/_properties.scss +0 -0
  165. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
  166. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
  167. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
  168. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
  169. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
  170. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
  171. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
  172. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/__init__.py +0 -0
  173. documenteer-2.0.0a3/src/documenteer/packagemetadata.py → documenteer-2.1.0/src/documenteer/_packagemetadata.py +1 -1
  174. /documenteer-2.0.0a3/src/documenteer/requestsutils.py → /documenteer-2.1.0/src/documenteer/_requestsutils.py +0 -0
  175. /documenteer-2.0.0a3/src/documenteer/utils.py → /documenteer-2.1.0/src/documenteer/_utils.py +0 -0
  176. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/.gitignore +0 -0
  177. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
  178. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
  179. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/favicon.ico +0 -0
  180. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
  181. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
  182. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
  183. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-favicon.svg +0 -0
  184. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-technote.css +0 -0
  185. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-technote.css.map +0 -0
  186. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
  187. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
  188. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
  189. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
  190. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/conf/__init__.py +0 -0
  191. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/conf/_toml.py +0 -0
  192. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/ext/__init__.py +0 -0
  193. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/py.typed +0 -0
  194. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/services/__init__.py +0 -0
  195. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/services/technotemigration.py +0 -0
  196. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/__init__.py +0 -0
  197. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/latex.py +0 -0
  198. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
  199. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
  200. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
  201. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
  202. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
  203. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
  204. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
  205. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
  206. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
  207. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/storage/localtemplates.py +0 -0
  208. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/pydata/autosummary_core/exception.rst +0 -0
  209. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +0 -0
  210. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/.gitkeep +0 -0
  211. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/components/.gitkeep +0 -0
  212. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
  213. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
  214. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/sections/header-article.html +0 -0
  215. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
  216. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer/version.py +0 -0
  217. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/dependency_links.txt +0 -0
  218. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/entry_points.txt +0 -0
  219. {documenteer-2.0.0a3 → documenteer-2.1.0}/src/documenteer.egg-info/top_level.txt +0 -0
  220. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/__init__.py +0 -0
  221. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/afw.doxygen.conf +0 -0
  222. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/authordb.yaml +0 -0
  223. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/doxygen.tag.zip +0 -0
  224. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
  225. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
  226. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/doc/manifest.yaml +0 -0
  227. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
  228. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
  229. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/include/README.md +0 -0
  230. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_alpha/src/README.md +0 -0
  231. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/data/package_beta/doc/README.md +0 -0
  232. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/ext/__init__.py +0 -0
  233. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/ext/jira_test.py +0 -0
  234. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/ext/lsstdocushare_test.py +0 -0
  235. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/ext/mockcoderefs_test.py +0 -0
  236. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/roots/test-autocppapi/conf.py +0 -0
  237. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
  238. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/roots/test-autocppapi/index.rst +0 -0
  239. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/services/__init__.py +0 -0
  240. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/storage/__init__.py +0 -0
  241. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/test_conf_toml.py +0 -0
  242. {documenteer-2.0.0a3 → documenteer-2.1.0}/tests/test_conf_utils.py +0 -0
  243. {documenteer-2.0.0a3 → documenteer-2.1.0}/webpack.config.js +0 -0
@@ -5,11 +5,12 @@
5
5
  name: Periodic CI
6
6
 
7
7
  env:
8
- PYTHON_VERSION: "3.12"
8
+ PYTHON_VERSION: "3.13"
9
9
 
10
10
  "on":
11
11
  schedule:
12
12
  - cron: "0 12 * * 1"
13
+ workflow_dispatch: {}
13
14
 
14
15
  jobs:
15
16
  lint:
@@ -44,6 +45,7 @@ jobs:
44
45
  python-version: ${{ env.PYTHON_VERSION }}
45
46
  tox-envs: 'lint'
46
47
  use-cache: false
48
+ tox-plugins: tox-uv
47
49
 
48
50
  - name: Report status
49
51
  if: failure()
@@ -61,7 +63,6 @@ jobs:
61
63
  strategy:
62
64
  matrix:
63
65
  python-version:
64
- - "3.11"
65
66
  - "3.12"
66
67
  - "3.13"
67
68
  sphinx-version:
@@ -89,10 +90,8 @@ jobs:
89
90
  npm install
90
91
  npm run build
91
92
 
92
- - name: Install graphviz
93
- run: |
94
- sudo apt-get update
95
- sudo apt-get install graphviz
93
+ - name: Setup Graphviz
94
+ uses: ts-graphviz/setup-graphviz@v2
96
95
 
97
96
  - name: Run tests in tox
98
97
  uses: lsst-sqre/run-tox@v1
@@ -100,6 +99,7 @@ jobs:
100
99
  python-version: ${{ matrix.python-version }}
101
100
  tox-envs: "typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
102
101
  use-cache: false
102
+ tox-plugins: tox-uv
103
103
 
104
104
  - name: Report status
105
105
  if: failure()
@@ -119,12 +119,32 @@ jobs:
119
119
  with:
120
120
  fetch-depth: 0 # full history for setuptools_scm
121
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
+
122
141
  - name: Build docs in tox
123
142
  uses: lsst-sqre/run-tox@v1
124
143
  with:
125
144
  python-version: ${{ env.PYTHON_VERSION }}
126
145
  tox-envs: "docs,docs-lint"
127
146
  use-cache: false
147
+ tox-plugins: tox-uv
128
148
 
129
149
  - name: Report status
130
150
  if: failure()
@@ -160,9 +180,8 @@ jobs:
160
180
  npm run build
161
181
 
162
182
  - name: Build and publish
163
- uses: lsst-sqre/build-and-publish-to-pypi@v2
183
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
164
184
  with:
165
- python-version: ${{ env.PYTHON_VERSION }}
166
185
  upload: false
167
186
 
168
187
  - name: Report status
@@ -1,7 +1,7 @@
1
1
  name: CI
2
2
 
3
3
  env:
4
- PYTHON_VERSION: '3.12' # Default Python version
4
+ PYTHON_VERSION: '3.13' # Default Python version
5
5
 
6
6
  'on':
7
7
  push:
@@ -50,6 +50,7 @@ jobs:
50
50
  with:
51
51
  python-version: ${{ env.PYTHON_VERSION }}
52
52
  tox-envs: 'lint'
53
+ tox-plugins: tox-uv
53
54
 
54
55
  test:
55
56
  runs-on: ubuntu-latest
@@ -57,7 +58,6 @@ jobs:
57
58
  strategy:
58
59
  matrix:
59
60
  python-version:
60
- - '3.11'
61
61
  - '3.12'
62
62
  - '3.13'
63
63
  sphinx-version:
@@ -85,16 +85,15 @@ jobs:
85
85
  npm install
86
86
  npm run build
87
87
 
88
- - name: Install graphviz
89
- run: |
90
- sudo apt-get update
91
- sudo apt-get install graphviz
88
+ - name: Setup Graphviz
89
+ uses: ts-graphviz/setup-graphviz@v2
92
90
 
93
91
  - name: Run tox
94
92
  uses: lsst-sqre/run-tox@v1
95
93
  with:
96
94
  python-version: ${{ matrix.python-version }}
97
95
  tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
96
+ tox-plugins: tox-uv
98
97
 
99
98
  docs:
100
99
  runs-on: ubuntu-latest
@@ -104,14 +103,31 @@ jobs:
104
103
  with:
105
104
  fetch-depth: 0 # full history for setuptools_scm
106
105
 
107
- - name: Install Graphviz
108
- 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
109
124
 
110
125
  - name: Run tox
111
126
  uses: lsst-sqre/run-tox@v1
112
127
  with:
113
128
  python-version: ${{ env.PYTHON_VERSION }}
114
129
  tox-envs: 'docs,docs-lint'
130
+ tox-plugins: tox-uv
115
131
 
116
132
  # Only attempt documentation uploads for tagged releases and pull
117
133
  # requests from ticket branches in the same repository. This avoids
@@ -136,10 +152,25 @@ jobs:
136
152
  with:
137
153
  fetch-depth: 0 # full history for setuptools_scm
138
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
+
139
171
  - name: Build and publish
140
- uses: lsst-sqre/build-and-publish-to-pypi@v2
172
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
141
173
  with:
142
- python-version: ${{ env.PYTHON_VERSION }}
143
174
  upload: "false"
144
175
 
145
176
  pypi-publish:
@@ -163,12 +194,16 @@ jobs:
163
194
  cache: 'npm'
164
195
  node-version-file: '.nvmrc'
165
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
+
166
203
  - name: npm install and build
167
204
  run: |
168
205
  npm install
169
206
  npm run build
170
207
 
171
208
  - name: Build and publish
172
- uses: lsst-sqre/build-and-publish-to-pypi@v2
173
- with:
174
- python-version: ${{ env.PYTHON_VERSION }}
209
+ uses: lsst-sqre/build-and-publish-to-pypi@v3
@@ -2,6 +2,136 @@
2
2
 
3
3
  <!-- scriv-insert-here -->
4
4
 
5
+ <a id='changelog-2.1.0'></a>
6
+ ## 2.1.0 (2025-07-16)
7
+
8
+ ### New features
9
+
10
+ - Improved and extended the nitpick ignore configurations for both user guides and technotes. The new configuration engine uses a common set of utility functions to generate the ignore patterns. Additionally, Documenteer makes better use of regex patterns to ignore linking issues to APIs that are not documented with Sphinx, such as `fastapi`, `httpx`, and `pydantic`. This should reduce the number of nitpick warnings in user guides and technotes, and generally reduce the need for manual nitpick ignores in projects.
11
+
12
+ - Added [`sphinx-sitemap`](https://sphinx-sitemap.readthedocs.io/en/latest/index.html) for generating sitemaps in Rubin user guides and technotes. This will improve search engine and LLM/agent indexing of documentation. In user guides, the sitemap is linked in the HTML `head` for better discoverability.
13
+ - A new extension, `documenteer.ext.robots`, helps you generate a `robots.txt` file to inform web crawlers about access to documentation sites. In this initial version, the `robots.txt` file is generated when a `sitemap.xml` file is available in order to link to that sitemap. The extension won't overwrite an existing `robots.txt` file.
14
+ - Documenteer's Sphinx extensions (`documenteer.ext.*`) now use Sphinx's built-in logging system, `sphinx.util.logging`, instead of the standard Python logging module.
15
+
16
+ - Rubin user guides (`documenteer.conf.guide`) now include Plausible.io analytics integration for privacy-preserving website analytics. The Plausible domain is configured by default to `lsst.io`, which is the common tracking domain for all Rubin Observatory technical documentation.
17
+
18
+ ### Bug fixes
19
+
20
+ - The Redoc site extension (`documenteer.ext.redoc`) now skips rendering early if the OpenAPI configuration is an empty list to avoid unnecessary processing.
21
+
22
+ <a id='changelog-2.0.0'></a>
23
+ ## 2.0.0 (2025-07-10)
24
+
25
+ ### Backwards-incompatible changes
26
+
27
+ - 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:
28
+
29
+ - `documenteer.stackdocs`
30
+ - Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
31
+ - CLI commands `stack-docs` and `package-docs`
32
+ - Sphinx extensions:
33
+ - `documenteer.ext.lssttasks`
34
+ - `documenteer.ext.packagetoctree`
35
+ - `documenteer.ext.autocppapi`
36
+ - `documenteer.ext.autodocreset`
37
+
38
+ - Dropped support for Python 3.11. Python 3.12 or later is now required.
39
+
40
+ - Removed `documenteer.requestutils`, `documenteer.packagemetadata`, and `documenteer.utils` from the public API.
41
+
42
+ ### New features
43
+
44
+ - User guide configuration improvements:
45
+
46
+ - 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.
47
+
48
+ - The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
49
+
50
+ - 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.
51
+
52
+ - Updated to pydata-sphinx-theme 0.16.
53
+
54
+ - Added [sphinx-favicon](https://sphinx-favicon.readthedocs.io/en/stable/index.html) for managing favicons in user guides.
55
+
56
+ - 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.
57
+
58
+ - 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.
59
+
60
+ - 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.
61
+
62
+ - 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.
63
+
64
+ - The entire `documenteer` code base is now type annotated.
65
+
66
+ ### Bug fixes
67
+
68
+ - Updated `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with Sphinx 8.1.0 and allows unpinning the Mermaid JS version.
69
+
70
+ - Pinned Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
71
+
72
+ - Documenteer's Sphinx extensions now provide proper extension metadata to support version-based cache busting and parallel builds.
73
+
74
+ ### Other changes
75
+
76
+ - The code base is now linted and formatted with ruff.
77
+
78
+ - Added testing against Sphinx 8 and Python 3.13 in GitHub Actions.
79
+
80
+ - Updated the technote creation documentation to reference `@Squarebot`, updated from `sqrbot-jr`.
81
+
82
+ - 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.
83
+
84
+ - Adopted [ts-graphviz/setup-graphviz](https://github.com/ts-graphviz/setup-graphviz) for installing Graphviz in GitHub Actions CI workflows.
85
+
86
+ - Updated how license information is encoded in `pyproject.toml`.
87
+
88
+ - Switched to dependency groups for development dependencies in `pyproject.toml`. With this change, Documenteer no longer publishes a `dev` extra to PyPI.
89
+
90
+ - Documenteer no longer depends on setuptools as a runtime dependency thanks to pybtex version 0.25 and `documenteer.ext.redoc`.
91
+
92
+ <a id='changelog-1.4.5'></a>
93
+ ## 1.4.5 (2025-06-25)
94
+
95
+ ### Other changes
96
+
97
+ - Update to lsst-sqre/build-and-publish-to-pypi@v3 for publishing to PyPI.
98
+
99
+ <a id='changelog-1.4.4'></a>
100
+ ## 1.4.4 (2025-06-25)
101
+
102
+ ### Bug fixes
103
+
104
+ - 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.
105
+
106
+ ### Other changes
107
+
108
+ - Add testing against Python 3.13 and Sphinx 8.
109
+
110
+ <a id='changelog-1.4.3'></a>
111
+ ## 1.4.3 (2025-02-19)
112
+
113
+ ### Bug fixes
114
+
115
+ - Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
116
+
117
+ ### Other changes
118
+
119
+ - 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.
120
+
121
+ <a id='changelog-1.4.2'></a>
122
+ ## 1.4.2 (2024-10-15)
123
+
124
+ ### Bug fixes
125
+
126
+ - Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
127
+
128
+ <a id='changelog-1.4.1'></a>
129
+ ## 1.4.1 (2024-10-10)
130
+
131
+ ### Bug fixes
132
+
133
+ - 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.
134
+
5
135
  <a id='changelog-1.4.0'></a>
6
136
  ## 1.4.0 (2024-07-11)
7
137
 
@@ -0,0 +1,25 @@
1
+ .PHONY: help
2
+ help:
3
+ @echo "Make command reference"
4
+ @echo " make init ........ (initialize for development)"
5
+ @echo " make clean ....... (clean up build artifacts)"
6
+ @echo " make update-deps . (update dependencies and pre-commit hooks)"
7
+
8
+ .PHONY: init
9
+ init:
10
+ rm -rf .tox
11
+ uv pip install --upgrade pre-commit tox tox-uv scriv
12
+ uv pip install -e ".[technote,pipelines]" --group dev
13
+ pre-commit install
14
+
15
+ .PHONY: clean
16
+ clean:
17
+ rm -rf .tox
18
+ rm -rf docs/_build
19
+ rm -rf docs/dev/api/contents/*.rst
20
+ make -C demo/rst-technote clean
21
+
22
+ .PHONY: update-deps
23
+ update-deps:
24
+ uv pip install --upgrade pre-commit
25
+ pre-commit autoupdate
@@ -1,29 +1,8 @@
1
- Metadata-Version: 2.2
1
+ Metadata-Version: 2.4
2
2
  Name: documenteer
3
- Version: 2.0.0a3
3
+ Version: 2.1.0
4
4
  Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
5
- License: The MIT License (MIT)
6
-
7
- Copyright (c) 2015-2022 Association of Universities for Research in Astronomy, Inc. (AURA)
8
-
9
- Permission is hereby granted, free of charge, to any person obtaining a copy
10
- of this software and associated documentation files (the "Software"), to deal
11
- in the Software without restriction, including without limitation the rights
12
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
- copies of the Software, and to permit persons to whom the Software is
14
- furnished to do so, subject to the following conditions:
15
-
16
- The above copyright notice and this permission notice shall be included in all
17
- copies or substantial portions of the Software.
18
-
19
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
- SOFTWARE.
26
-
5
+ License-Expression: MIT
27
6
  Project-URL: Homepage, https://documenteer.lsst.io
28
7
  Project-URL: Source, https://github.com/lsst-sqre/documenteer
29
8
  Keywords: rubin,lsst
@@ -31,51 +10,39 @@ Classifier: Development Status :: 5 - Production/Stable
31
10
  Classifier: Environment :: Console
32
11
  Classifier: Framework :: Sphinx :: Extension
33
12
  Classifier: Intended Audience :: Developers
34
- Classifier: License :: OSI Approved :: MIT License
35
13
  Classifier: Natural Language :: English
36
14
  Classifier: Operating System :: POSIX
37
15
  Classifier: Programming Language :: Python
38
16
  Classifier: Programming Language :: Python :: 3
39
- Classifier: Programming Language :: Python :: 3.11
40
17
  Classifier: Programming Language :: Python :: 3.12
41
18
  Classifier: Programming Language :: Python :: 3.13
42
19
  Classifier: Topic :: Documentation
43
20
  Classifier: Topic :: Documentation :: Sphinx
44
21
  Classifier: Typing :: Typed
45
- Requires-Python: >=3.11
22
+ Requires-Python: >=3.12
46
23
  Description-Content-Type: text/markdown
47
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
48
30
  Requires-Dist: docutils>=0.20
49
31
  Requires-Dist: Sphinx<8.2,>=7
50
32
  Requires-Dist: PyYAML
51
33
  Requires-Dist: GitPython
52
34
  Requires-Dist: requests
53
35
  Requires-Dist: click
54
- Requires-Dist: sphinxcontrib-bibtex>=2.0.0
55
- Requires-Dist: setuptools
36
+ Requires-Dist: sphinxcontrib-bibtex>=2.6.5
37
+ Requires-Dist: pybtex>=0.25.0
56
38
  Requires-Dist: pydantic>=2.0.0
57
39
  Requires-Dist: urllib3
58
40
  Requires-Dist: pylatexenc
59
41
  Requires-Dist: tomlkit
60
- Provides-Extra: dev
61
- Requires-Dist: twine; extra == "dev"
62
- Requires-Dist: coverage[toml]; extra == "dev"
63
- Requires-Dist: pytest; extra == "dev"
64
- Requires-Dist: pytest-mock; extra == "dev"
65
- Requires-Dist: lxml; extra == "dev"
66
- Requires-Dist: cssselect; extra == "dev"
67
- Requires-Dist: defusedxml; extra == "dev"
68
- Requires-Dist: sphinx-click; extra == "dev"
69
- Requires-Dist: sphinxcontrib-autoprogram; extra == "dev"
70
- Requires-Dist: types-setuptools; extra == "dev"
71
- Requires-Dist: types-requests; extra == "dev"
72
- Requires-Dist: types-PyYAML; extra == "dev"
73
- Requires-Dist: types-docutils; extra == "dev"
74
- Requires-Dist: types-mock; extra == "dev"
75
42
  Provides-Extra: guide
76
43
  Requires-Dist: autodoc_pydantic; extra == "guide"
77
44
  Requires-Dist: sphinx_design; extra == "guide"
78
- Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
45
+ Requires-Dist: pydata-sphinx-theme<0.17.0,>=0.16.1; extra == "guide"
79
46
  Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
80
47
  Requires-Dist: sphinx-automodapi; extra == "guide"
81
48
  Requires-Dist: sphinx-copybutton; extra == "guide"
@@ -86,29 +53,32 @@ Requires-Dist: myst-nb; extra == "guide"
86
53
  Requires-Dist: markdown-it-py[linkify]; extra == "guide"
87
54
  Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
88
55
  Requires-Dist: sphinxext-opengraph; extra == "guide"
89
- Requires-Dist: sphinxcontrib-redoc; extra == "guide"
90
56
  Requires-Dist: sphinxcontrib-jquery; extra == "guide"
91
57
  Requires-Dist: sphinxext-rediraffe; extra == "guide"
92
58
  Requires-Dist: sphinxcontrib-youtube; extra == "guide"
59
+ Requires-Dist: sphinx-favicon; extra == "guide"
60
+ Requires-Dist: sphinx-sitemap; extra == "guide"
93
61
  Provides-Extra: technote
94
62
  Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
95
63
  Requires-Dist: sphinx-prompt; extra == "technote"
96
- Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
64
+ Requires-Dist: sphinxcontrib-mermaid>=1; extra == "technote"
97
65
  Requires-Dist: sphinx-diagrams; extra == "technote"
98
66
  Requires-Dist: sphinx_design; extra == "technote"
99
67
  Requires-Dist: myst-nb; extra == "technote"
100
68
  Requires-Dist: sphinxcontrib-youtube; extra == "technote"
69
+ Requires-Dist: sphinx-sitemap; extra == "technote"
70
+ Dynamic: license-file
101
71
 
102
72
  [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
103
73
  [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
104
- [![For Python 3.7+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
74
+ [![For Python 3.12+](https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
105
75
  [![MIT license](https://img.shields.io/pypi/l/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)
106
76
  [![CI](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
107
77
  [![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)
108
78
 
109
79
  # Documenteer
110
80
 
111
- 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)).
81
+ 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).
112
82
 
113
83
  For more information about Documenteer, see the documentation at https://documenteer.lsst.io.
114
84
 
@@ -127,9 +97,3 @@ For [technical note projects](https://documenteer.lsst.io/technotes/index.html):
127
97
  ```sh
128
98
  pip install "documenteer[technote]"
129
99
  ```
130
-
131
- For the [stack projects](https://documenteer.lsst.io/pipelines/index.html) (such as the [LSST Science Pipelines](https://pipelines.lsst.io)):
132
-
133
- ```sh
134
- pip install "documenteer[pipelines]"
135
- ```
@@ -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,7 @@
1
1
  # Makefile for Sphinx documentation
2
2
 
3
3
  # You can set these variables from the command line.
4
- SPHINXOPTS = -n -W
4
+ SPHINXOPTS = -n
5
5
  SPHINXBUILD = sphinx-build
6
6
  BUILDDIR = _build
7
7