documenteer 1.4.5__tar.gz → 2.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- documenteer-2.0.0/.github/workflows/ci-cron.yaml +195 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.github/workflows/ci.yaml +54 -14
- {documenteer-1.4.5 → documenteer-2.0.0}/.pre-commit-config.yaml +9 -19
- documenteer-2.0.0/.vscode/settings.json +4 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/CHANGELOG.md +70 -0
- documenteer-2.0.0/Makefile +25 -0
- {documenteer-1.4.5/src/documenteer.egg-info → documenteer-2.0.0}/PKG-INFO +26 -56
- {documenteer-1.4.5 → documenteer-2.0.0}/README.md +2 -8
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/Makefile +0 -1
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/_rst_epilog.rst +1 -6
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/changelog.md +70 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/api/documenteer.ext.rst +0 -7
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/api/index.rst +0 -3
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/documenteer.toml +10 -8
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/index.rst +0 -8
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/page-redirects.rst +1 -1
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/index.rst +1 -15
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/index.rst +0 -10
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/edit-on-github.rst +1 -1
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/start-a-technote.rst +1 -1
- documenteer-2.0.0/licenses/README.md +9 -0
- documenteer-2.0.0/licenses/sphinxcontrib-redoc.txt +23 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/pyproject.toml +113 -72
- documenteer-2.0.0/ruff-shared.toml +139 -0
- documenteer-1.4.5/src/documenteer/packagemetadata.py → documenteer-2.0.0/src/documenteer/_packagemetadata.py +9 -23
- documenteer-1.4.5/src/documenteer/requestsutils.py → documenteer-2.0.0/src/documenteer/_requestsutils.py +8 -7
- documenteer-1.4.5/src/documenteer/utils.py → documenteer-2.0.0/src/documenteer/_utils.py +11 -13
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-pydata-theme.css +16 -9
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/cli.py +11 -9
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/conf/_toml.py +45 -55
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/conf/_utils.py +4 -7
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/conf/guide.py +101 -35
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/conf/technote.py +19 -11
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/bibtex.py +13 -2
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/githubbibcache.py +4 -3
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/jira.py +58 -35
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/lsstdocushare.py +27 -17
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/mockcoderefs.py +25 -4
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/openapi.py +8 -7
- documenteer-2.0.0/src/documenteer/ext/redoc/__init__.py +5 -0
- documenteer-2.0.0/src/documenteer/ext/redoc/_redoc.py +131 -0
- documenteer-2.0.0/src/documenteer/ext/redoc/assets/redoc.html.jinja2 +36 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/remotecodeblock.py +29 -31
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/services/technoteauthor.py +7 -15
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/services/technotemigration.py +21 -14
- documenteer-2.0.0/src/documenteer/storage/authordb.py +102 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/conf.py +1 -1
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates.py +1 -1
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/technotetoml.py +15 -18
- documenteer-2.0.0/src/documenteer/templates/pydata/autosummary_core/exception.rst +15 -0
- documenteer-2.0.0/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +11 -0
- {documenteer-1.4.5 → documenteer-2.0.0/src/documenteer.egg-info}/PKG-INFO +26 -56
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer.egg-info/SOURCES.txt +17 -53
- documenteer-2.0.0/src/documenteer.egg-info/entry_points.txt +2 -0
- documenteer-2.0.0/src/documenteer.egg-info/requires.txt +40 -0
- documenteer-2.0.0/tests/conftest.py +18 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/ext/jira_test.py +6 -5
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/ext/lsstdocushare_test.py +7 -5
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/ext/mockcoderefs_test.py +13 -11
- documenteer-2.0.0/tests/ext/redoc_test.py +88 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/packagemetadata_test.py +1 -1
- documenteer-2.0.0/tests/roots/test-redoc/_static/openapi.json +1 -0
- documenteer-2.0.0/tests/roots/test-redoc/api.rst +5 -0
- documenteer-2.0.0/tests/roots/test-redoc/conf.py +1 -0
- documenteer-2.0.0/tests/roots/test-redoc/documenteer.toml +10 -0
- documenteer-2.0.0/tests/roots/test-redoc/index.rst +8 -0
- documenteer-2.0.0/tests/services/technotemigration_test.py +104 -0
- documenteer-2.0.0/tests/storage/authordb_test.py +64 -0
- documenteer-2.0.0/tests/storage/technotetoml_test.py +125 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/test_conf_toml.py +3 -5
- {documenteer-1.4.5 → documenteer-2.0.0}/tox.ini +22 -11
- documenteer-1.4.5/.github/workflows/ci-cron.yaml +0 -97
- documenteer-1.4.5/.github/workflows/dependencies.yaml +0 -33
- documenteer-1.4.5/.vscode/settings.json +0 -6
- documenteer-1.4.5/Makefile +0 -18
- documenteer-1.4.5/docs/dev/api/documenteer.requestsutils.rst +0 -6
- documenteer-1.4.5/docs/dev/api/documenteer.sphinxrunner.rst +0 -6
- documenteer-1.4.5/docs/dev/api/documenteer.stackdocs.rst +0 -21
- documenteer-1.4.5/docs/guides/pipelines/build-overview.rst +0 -112
- documenteer-1.4.5/docs/guides/pipelines/configuration.rst +0 -84
- documenteer-1.4.5/docs/guides/pipelines/cpp-api-linking.rst +0 -116
- documenteer-1.4.5/docs/guides/pipelines/index.rst +0 -17
- documenteer-1.4.5/docs/guides/pipelines/install.rst +0 -45
- documenteer-1.4.5/docs/guides/pipelines/package-docs-cli.rst +0 -15
- documenteer-1.4.5/docs/guides/pipelines/stack-docs-cli.rst +0 -15
- documenteer-1.4.5/docs/sphinx-extensions/autocppapi.rst +0 -69
- documenteer-1.4.5/docs/sphinx-extensions/autodocreset.rst +0 -22
- documenteer-1.4.5/docs/sphinx-extensions/lssttasks.rst +0 -376
- documenteer-1.4.5/docs/sphinx-extensions/package-toctree.rst +0 -76
- documenteer-1.4.5/licenses/README.md +0 -4
- documenteer-1.4.5/src/documenteer/conf/pipelines.py +0 -224
- documenteer-1.4.5/src/documenteer/conf/pipelinespkg.py +0 -15
- documenteer-1.4.5/src/documenteer/ext/_utils.py +0 -210
- documenteer-1.4.5/src/documenteer/ext/autocppapi.py +0 -307
- documenteer-1.4.5/src/documenteer/ext/autodocreset.py +0 -26
- documenteer-1.4.5/src/documenteer/ext/lssttasks/__init__.py +0 -84
- documenteer-1.4.5/src/documenteer/ext/lssttasks/configfieldlists.py +0 -1179
- documenteer-1.4.5/src/documenteer/ext/lssttasks/crossrefs.py +0 -397
- documenteer-1.4.5/src/documenteer/ext/lssttasks/pyapisummary.py +0 -320
- documenteer-1.4.5/src/documenteer/ext/lssttasks/taskutils.py +0 -221
- documenteer-1.4.5/src/documenteer/ext/lssttasks/topiclists.py +0 -276
- documenteer-1.4.5/src/documenteer/ext/lssttasks/topics.py +0 -169
- documenteer-1.4.5/src/documenteer/ext/packagetoctree.py +0 -245
- documenteer-1.4.5/src/documenteer/sphinxrunner.py +0 -69
- documenteer-1.4.5/src/documenteer/stackdocs/build.py +0 -307
- documenteer-1.4.5/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -35489
- documenteer-1.4.5/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -2414
- documenteer-1.4.5/src/documenteer/stackdocs/data/mainpage.dox +0 -9
- documenteer-1.4.5/src/documenteer/stackdocs/doxygen.py +0 -732
- documenteer-1.4.5/src/documenteer/stackdocs/doxygentag.py +0 -59
- documenteer-1.4.5/src/documenteer/stackdocs/packagecli.py +0 -142
- documenteer-1.4.5/src/documenteer/stackdocs/pkgdiscovery.py +0 -308
- documenteer-1.4.5/src/documenteer/stackdocs/rootdiscovery.py +0 -118
- documenteer-1.4.5/src/documenteer/stackdocs/stackcli.py +0 -342
- documenteer-1.4.5/src/documenteer/storage/authordb.py +0 -173
- documenteer-1.4.5/src/documenteer.egg-info/entry_points.txt +0 -4
- documenteer-1.4.5/src/documenteer.egg-info/requires.txt +0 -73
- documenteer-1.4.5/tests/conftest.py +0 -21
- documenteer-1.4.5/tests/ext/autocppapi_test.py +0 -38
- documenteer-1.4.5/tests/ext/lssttasks/taskutils_test.py +0 -32
- documenteer-1.4.5/tests/ext/packagetoctree_test.py +0 -20
- documenteer-1.4.5/tests/ext/utils_test.py +0 -25
- documenteer-1.4.5/tests/services/technotemigration_test.py +0 -73
- documenteer-1.4.5/tests/storage/__init__.py +0 -0
- documenteer-1.4.5/tests/storage/authordb_test.py +0 -34
- documenteer-1.4.5/tests/storage/technotetoml_test.py +0 -60
- documenteer-1.4.5/tests/test_stackdocs_build.py +0 -77
- documenteer-1.4.5/tests/test_stackdocs_doxygen.py +0 -168
- documenteer-1.4.5/tests/test_stackdocs_doxygentag.py +0 -48
- documenteer-1.4.5/tests/test_stackdocs_pkgdiscovery.py +0 -65
- documenteer-1.4.5/tests/test_stackdocs_rootdiscovery.py +0 -117
- {documenteer-1.4.5 → documenteer-2.0.0}/.flake8 +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.github/CODE_OF_CONDUCT.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.github/CONTRIBUTING.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.github/SUPPORT.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.github/dependabot.yml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.npmrc +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.nvmrc +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.prettierignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.prettierrc.yaml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/.vscode/tasks.json +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/LICENSE +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/MANIFEST.in +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/changelog.d/_template.md.jinja +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/Makefile +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/conf.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/diagram.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/index.ipynb +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/ipynb-technote/technote.toml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/Makefile +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/conf.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/diagram.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/index.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/md-technote/technote.toml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/Makefile +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/conf.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/diagram.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/index.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/demo/rst-technote/technote.toml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/conf.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/api/documenteer.conf.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/development.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/html-templates.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/index.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/release.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/theme-assets.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/dev/theme.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/badges.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/configuration-preset.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/configuration.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/diagrams.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/extend-conf-py.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/including-notebooks.ipynb +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/markdown-primer.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/openapi.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/organization.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/overview.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/pyproject-configuration.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/rst-epilog.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/tabsets.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/toml-reference.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/guides/video-embeds.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/docushare-reference.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/githubbibcache.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/jira-reference.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/openapi.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/sphinx-extensions/remote-code-block.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/_templates/README.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/_templates/README.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/author-metadata.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/configuration.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/document-status.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/edit-locally.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/extensions.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/how-your-technote-gets-published.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/index.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/migrate.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/docs/technotes/wide-content.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/licenses/astropy-helpers.txt +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/licenses/sphinx-issue.txt +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/licenses/sphinx.txt +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/package-lock.json +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/package.json +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/postcss.config.js +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/setup.cfg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/_properties.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/.gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/favicon.ico +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-favicon.svg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-technote.css +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-technote.css.map +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/conf/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/ext/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/py.typed +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/services/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/latex.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/pydata/layout.html +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/.gitkeep +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/components/.gitkeep +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/header-article.html +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer/version.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer.egg-info/dependency_links.txt +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/src/documenteer.egg-info/top_level.txt +0 -0
- {documenteer-1.4.5/src/documenteer/stackdocs → documenteer-2.0.0/tests}/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/afw.doxygen.conf +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/authordb.yaml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/doxygen.tag.zip +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/doc/manifest.yaml +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/include/README.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_alpha/src/README.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/data/package_beta/doc/README.md +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/ext/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/roots/test-autocppapi/conf.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/roots/test-autocppapi/index.rst +0 -0
- {documenteer-1.4.5/tests/ext/lssttasks → documenteer-2.0.0/tests/services}/__init__.py +0 -0
- {documenteer-1.4.5/tests/services → documenteer-2.0.0/tests/storage}/__init__.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/tests/test_conf_utils.py +0 -0
- {documenteer-1.4.5 → documenteer-2.0.0}/webpack.config.js +0 -0
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
# This is a separate run of the Python test suite that doesn't cache the tox
|
|
2
|
+
# environment and runs from a schedule. The purpose is to test compatibility
|
|
3
|
+
# with the latest versions of dependencies.
|
|
4
|
+
|
|
5
|
+
name: Periodic CI
|
|
6
|
+
|
|
7
|
+
env:
|
|
8
|
+
PYTHON_VERSION: "3.13"
|
|
9
|
+
|
|
10
|
+
"on":
|
|
11
|
+
schedule:
|
|
12
|
+
- cron: "0 12 * * 1"
|
|
13
|
+
workflow_dispatch: {}
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
lint:
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
|
|
21
|
+
- name: Set up Python
|
|
22
|
+
uses: actions/setup-python@v5
|
|
23
|
+
with:
|
|
24
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
25
|
+
|
|
26
|
+
- uses: actions/setup-node@v4
|
|
27
|
+
with:
|
|
28
|
+
cache: 'npm'
|
|
29
|
+
node-version-file: '.nvmrc'
|
|
30
|
+
|
|
31
|
+
- name: Authenticate GitHub Packages
|
|
32
|
+
run: |
|
|
33
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
34
|
+
env:
|
|
35
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
36
|
+
|
|
37
|
+
- name: npm install and build
|
|
38
|
+
run: |
|
|
39
|
+
npm install
|
|
40
|
+
npm run build
|
|
41
|
+
|
|
42
|
+
- name: Run tox
|
|
43
|
+
uses: lsst-sqre/run-tox@v1
|
|
44
|
+
with:
|
|
45
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
46
|
+
tox-envs: 'lint'
|
|
47
|
+
use-cache: false
|
|
48
|
+
tox-plugins: tox-uv
|
|
49
|
+
|
|
50
|
+
- name: Report status
|
|
51
|
+
if: failure()
|
|
52
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
53
|
+
with:
|
|
54
|
+
status: ${{ job.status }}
|
|
55
|
+
notify_when: "failure"
|
|
56
|
+
notification_title: "Periodic lint for {repo} failed"
|
|
57
|
+
env:
|
|
58
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
59
|
+
|
|
60
|
+
test:
|
|
61
|
+
runs-on: ubuntu-latest
|
|
62
|
+
|
|
63
|
+
strategy:
|
|
64
|
+
matrix:
|
|
65
|
+
python-version:
|
|
66
|
+
- "3.12"
|
|
67
|
+
- "3.13"
|
|
68
|
+
sphinx-version:
|
|
69
|
+
- "7"
|
|
70
|
+
- "8"
|
|
71
|
+
- "dev"
|
|
72
|
+
|
|
73
|
+
steps:
|
|
74
|
+
- uses: actions/checkout@v4
|
|
75
|
+
with:
|
|
76
|
+
fetch-depth: 0 # full history for setuptools_scm
|
|
77
|
+
|
|
78
|
+
- uses: actions/setup-node@v4
|
|
79
|
+
with:
|
|
80
|
+
node-version-file: '.nvmrc'
|
|
81
|
+
|
|
82
|
+
- name: Authenticate GitHub Packages
|
|
83
|
+
run: |
|
|
84
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
85
|
+
env:
|
|
86
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
87
|
+
|
|
88
|
+
- name: npm install and build
|
|
89
|
+
run: |
|
|
90
|
+
npm install
|
|
91
|
+
npm run build
|
|
92
|
+
|
|
93
|
+
- name: Setup Graphviz
|
|
94
|
+
uses: ts-graphviz/setup-graphviz@v2
|
|
95
|
+
|
|
96
|
+
- name: Run tests in tox
|
|
97
|
+
uses: lsst-sqre/run-tox@v1
|
|
98
|
+
with:
|
|
99
|
+
python-version: ${{ matrix.python-version }}
|
|
100
|
+
tox-envs: "typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
|
|
101
|
+
use-cache: false
|
|
102
|
+
tox-plugins: tox-uv
|
|
103
|
+
|
|
104
|
+
- name: Report status
|
|
105
|
+
if: failure()
|
|
106
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
107
|
+
with:
|
|
108
|
+
status: ${{ job.status }}
|
|
109
|
+
notify_when: "failure"
|
|
110
|
+
notification_title: "Periodic test for {repo} failed"
|
|
111
|
+
env:
|
|
112
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
113
|
+
|
|
114
|
+
docs:
|
|
115
|
+
runs-on: ubuntu-latest
|
|
116
|
+
|
|
117
|
+
steps:
|
|
118
|
+
- uses: actions/checkout@v4
|
|
119
|
+
with:
|
|
120
|
+
fetch-depth: 0 # full history for setuptools_scm
|
|
121
|
+
|
|
122
|
+
- uses: actions/setup-node@v4
|
|
123
|
+
with:
|
|
124
|
+
cache: 'npm'
|
|
125
|
+
node-version-file: '.nvmrc'
|
|
126
|
+
|
|
127
|
+
- name: Authenticate GitHub Packages
|
|
128
|
+
run: |
|
|
129
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
130
|
+
env:
|
|
131
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
132
|
+
|
|
133
|
+
- name: npm install and build
|
|
134
|
+
run: |
|
|
135
|
+
npm install
|
|
136
|
+
npm run build
|
|
137
|
+
|
|
138
|
+
- name: Setup Graphviz
|
|
139
|
+
uses: ts-graphviz/setup-graphviz@v2
|
|
140
|
+
|
|
141
|
+
- name: Build docs in tox
|
|
142
|
+
uses: lsst-sqre/run-tox@v1
|
|
143
|
+
with:
|
|
144
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
145
|
+
tox-envs: "docs,docs-lint"
|
|
146
|
+
use-cache: false
|
|
147
|
+
tox-plugins: tox-uv
|
|
148
|
+
|
|
149
|
+
- name: Report status
|
|
150
|
+
if: failure()
|
|
151
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
152
|
+
with:
|
|
153
|
+
status: ${{ job.status }}
|
|
154
|
+
notify_when: "failure"
|
|
155
|
+
notification_title: "Periodic documentation test for {repo} failed"
|
|
156
|
+
env:
|
|
157
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
158
|
+
|
|
159
|
+
pypi:
|
|
160
|
+
runs-on: ubuntu-latest
|
|
161
|
+
|
|
162
|
+
steps:
|
|
163
|
+
- uses: actions/checkout@v4
|
|
164
|
+
with:
|
|
165
|
+
fetch-depth: 0 # full history for setuptools_scm
|
|
166
|
+
|
|
167
|
+
- uses: actions/setup-node@v4
|
|
168
|
+
with:
|
|
169
|
+
node-version-file: '.nvmrc'
|
|
170
|
+
|
|
171
|
+
- name: Authenticate GitHub Packages
|
|
172
|
+
run: |
|
|
173
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
174
|
+
env:
|
|
175
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
176
|
+
|
|
177
|
+
- name: npm install and build
|
|
178
|
+
run: |
|
|
179
|
+
npm install
|
|
180
|
+
npm run build
|
|
181
|
+
|
|
182
|
+
- name: Build and publish
|
|
183
|
+
uses: lsst-sqre/build-and-publish-to-pypi@v3
|
|
184
|
+
with:
|
|
185
|
+
upload: false
|
|
186
|
+
|
|
187
|
+
- name: Report status
|
|
188
|
+
if: failure()
|
|
189
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
190
|
+
with:
|
|
191
|
+
status: ${{ job.status }}
|
|
192
|
+
notify_when: "failure"
|
|
193
|
+
notification_title: "Periodic packaging test for {repo} failed"
|
|
194
|
+
env:
|
|
195
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
name: CI
|
|
2
2
|
|
|
3
|
+
env:
|
|
4
|
+
PYTHON_VERSION: '3.13' # Default Python version
|
|
5
|
+
|
|
3
6
|
'on':
|
|
4
7
|
push:
|
|
5
8
|
branches-ignore:
|
|
@@ -24,7 +27,7 @@ jobs:
|
|
|
24
27
|
- name: Set up Python
|
|
25
28
|
uses: actions/setup-python@v5
|
|
26
29
|
with:
|
|
27
|
-
python-version:
|
|
30
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
28
31
|
|
|
29
32
|
- uses: actions/setup-node@v4
|
|
30
33
|
with:
|
|
@@ -45,8 +48,9 @@ jobs:
|
|
|
45
48
|
- name: Run tox
|
|
46
49
|
uses: lsst-sqre/run-tox@v1
|
|
47
50
|
with:
|
|
48
|
-
python-version:
|
|
51
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
49
52
|
tox-envs: 'lint'
|
|
53
|
+
tox-plugins: tox-uv
|
|
50
54
|
|
|
51
55
|
test:
|
|
52
56
|
runs-on: ubuntu-latest
|
|
@@ -54,7 +58,6 @@ jobs:
|
|
|
54
58
|
strategy:
|
|
55
59
|
matrix:
|
|
56
60
|
python-version:
|
|
57
|
-
- '3.11'
|
|
58
61
|
- '3.12'
|
|
59
62
|
- '3.13'
|
|
60
63
|
sphinx-version:
|
|
@@ -82,33 +85,49 @@ jobs:
|
|
|
82
85
|
npm install
|
|
83
86
|
npm run build
|
|
84
87
|
|
|
85
|
-
- name:
|
|
86
|
-
|
|
87
|
-
sudo apt-get update
|
|
88
|
-
sudo apt-get install graphviz
|
|
88
|
+
- name: Setup Graphviz
|
|
89
|
+
uses: ts-graphviz/setup-graphviz@v2
|
|
89
90
|
|
|
90
91
|
- name: Run tox
|
|
91
92
|
uses: lsst-sqre/run-tox@v1
|
|
92
93
|
with:
|
|
93
94
|
python-version: ${{ matrix.python-version }}
|
|
94
|
-
tox-envs: '
|
|
95
|
+
tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
|
|
96
|
+
tox-plugins: tox-uv
|
|
95
97
|
|
|
96
98
|
docs:
|
|
97
99
|
runs-on: ubuntu-latest
|
|
98
100
|
|
|
99
101
|
steps:
|
|
100
|
-
- uses: actions/checkout@
|
|
102
|
+
- uses: actions/checkout@v4
|
|
101
103
|
with:
|
|
102
104
|
fetch-depth: 0 # full history for setuptools_scm
|
|
103
105
|
|
|
104
|
-
- name:
|
|
105
|
-
|
|
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
|
|
106
124
|
|
|
107
125
|
- name: Run tox
|
|
108
126
|
uses: lsst-sqre/run-tox@v1
|
|
109
127
|
with:
|
|
110
|
-
python-version:
|
|
128
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
111
129
|
tox-envs: 'docs,docs-lint'
|
|
130
|
+
tox-plugins: tox-uv
|
|
112
131
|
|
|
113
132
|
# Only attempt documentation uploads for tagged releases and pull
|
|
114
133
|
# requests from ticket branches in the same repository. This avoids
|
|
@@ -124,7 +143,6 @@ jobs:
|
|
|
124
143
|
if: >
|
|
125
144
|
github.event_name != 'pull_request' || startsWith(github.head_ref, 'tickets/')
|
|
126
145
|
|
|
127
|
-
|
|
128
146
|
test-package:
|
|
129
147
|
name: Test PyPI package build
|
|
130
148
|
runs-on: ubuntu-latest
|
|
@@ -134,10 +152,26 @@ jobs:
|
|
|
134
152
|
with:
|
|
135
153
|
fetch-depth: 0 # full history for setuptools_scm
|
|
136
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
|
+
|
|
137
171
|
- name: Build and publish
|
|
138
172
|
uses: lsst-sqre/build-and-publish-to-pypi@v3
|
|
139
173
|
with:
|
|
140
|
-
upload:
|
|
174
|
+
upload: "false"
|
|
141
175
|
|
|
142
176
|
pypi-publish:
|
|
143
177
|
name: Upload release to PyPI
|
|
@@ -160,6 +194,12 @@ jobs:
|
|
|
160
194
|
cache: 'npm'
|
|
161
195
|
node-version-file: '.nvmrc'
|
|
162
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
|
+
|
|
163
203
|
- name: npm install and build
|
|
164
204
|
run: |
|
|
165
205
|
npm install
|
|
@@ -14,26 +14,16 @@ repos:
|
|
|
14
14
|
- id: rst-linter
|
|
15
15
|
files: (README\.rst)|(CHANGELOG\.rst)
|
|
16
16
|
|
|
17
|
-
- repo: https://github.com/
|
|
18
|
-
rev:
|
|
17
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
18
|
+
rev: v0.6.1
|
|
19
19
|
hooks:
|
|
20
|
-
- id:
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
- id: ruff
|
|
21
|
+
args: [--fix, --exit-non-zero-on-fix]
|
|
22
|
+
- id: ruff-format
|
|
23
23
|
|
|
24
|
-
- repo: https://github.com/
|
|
25
|
-
rev:
|
|
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==
|
|
34
|
-
args: [-l, '79', -t,
|
|
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]
|
|
@@ -2,6 +2,76 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- scriv-insert-here -->
|
|
4
4
|
|
|
5
|
+
<a id='changelog-2.0.0'></a>
|
|
6
|
+
## 2.0.0 (2025-07-10)
|
|
7
|
+
|
|
8
|
+
### Backwards-incompatible changes
|
|
9
|
+
|
|
10
|
+
- All Science Pipelines-related tooling and Sphinx extensions have been removed from Documenteer and moved to a new Science Pipelines package called `sphinxutils` (https://github.com/lsst-dm/sphinxutils). Removed components include:
|
|
11
|
+
|
|
12
|
+
- `documenteer.stackdocs`
|
|
13
|
+
- Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
|
|
14
|
+
- CLI commands `stack-docs` and `package-docs`
|
|
15
|
+
- Sphinx extensions:
|
|
16
|
+
- `documenteer.ext.lssttasks`
|
|
17
|
+
- `documenteer.ext.packagetoctree`
|
|
18
|
+
- `documenteer.ext.autocppapi`
|
|
19
|
+
- `documenteer.ext.autodocreset`
|
|
20
|
+
|
|
21
|
+
- Dropped support for Python 3.11. Python 3.12 or later is now required.
|
|
22
|
+
|
|
23
|
+
- Removed `documenteer.requestutils`, `documenteer.packagemetadata`, and `documenteer.utils` from the public API.
|
|
24
|
+
|
|
25
|
+
### New features
|
|
26
|
+
|
|
27
|
+
- User guide configuration improvements:
|
|
28
|
+
|
|
29
|
+
- New custom automodapi templates for Pydantic BaseModels and exceptions. The exception template ensures that inherited members of exceptions are documented. The Pydantic BaseModel template ensures that inherited members from the `BaseModel` class itself are _not_ documented. These templates were originally developed as part of [Gafaelfawr](https://github.com/lsst-sqre/gafaelfawr). Now users of the user guide configuration benefit from these templates without any additional configuration.
|
|
30
|
+
|
|
31
|
+
- The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
|
|
32
|
+
|
|
33
|
+
- The `documenteer.conf.guide` configuration now ignores common Sphinx warnings when including references to projects that don't use Sphinx/Intersphinx for their documentation, including Pydantic and FastAPI.
|
|
34
|
+
|
|
35
|
+
- Updated to pydata-sphinx-theme 0.16.
|
|
36
|
+
|
|
37
|
+
- Added [sphinx-favicon](https://sphinx-favicon.readthedocs.io/en/stable/index.html) for managing favicons in user guides.
|
|
38
|
+
|
|
39
|
+
- For embedding a redoc page for API documentation, Documenteer now provides its own `documenteer.ext.redoc` extension. This replaces the previous `sphinxcontrib.redoc` extension, which is not being actively maintained. This new extension is automatically configured through `documenteer.conf.guide`, and therefore should not require any changes for most user guide projects. `documenteer.ext.redoc` drops support for referencing an OpenAPI specification file from a web URL. FastAPI projects can use `documenteer.ext.openapi` to generate an OpenAPI specification file from the FastAPI app.
|
|
40
|
+
|
|
41
|
+
- In Markdown content for technotes and guides, Mermaid diagrams can now be written in code fences using the `mermaid` language tag. This is also supported in GitHub's Markdown renderer. The traditional method of using the `mermaid` directive syntax is still supported.
|
|
42
|
+
|
|
43
|
+
- Documenteer's `technote` and `guide` configurations now ignore pending Sphinx API deprecation warnings by default. This is to prevent the warnings from cluttering the build output, and are only useful for the Documenteer developers since the Sphinx version is constrained by Documenteer.
|
|
44
|
+
|
|
45
|
+
- The `documenteer` `add-authors` and `sync-authors` CLI commands now use the Ook web API to get author information, rather than directly reading `authordb.yaml` from lsst/lsst-texmf.
|
|
46
|
+
|
|
47
|
+
- The entire `documenteer` code base is now type annotated.
|
|
48
|
+
|
|
49
|
+
### Bug fixes
|
|
50
|
+
|
|
51
|
+
- Updated `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with Sphinx 8.1.0 and allows unpinning the Mermaid JS version.
|
|
52
|
+
|
|
53
|
+
- Pinned Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
|
|
54
|
+
|
|
55
|
+
- Documenteer's Sphinx extensions now provide proper extension metadata to support version-based cache busting and parallel builds.
|
|
56
|
+
|
|
57
|
+
### Other changes
|
|
58
|
+
|
|
59
|
+
- The code base is now linted and formatted with ruff.
|
|
60
|
+
|
|
61
|
+
- Added testing against Sphinx 8 and Python 3.13 in GitHub Actions.
|
|
62
|
+
|
|
63
|
+
- Updated the technote creation documentation to reference `@Squarebot`, updated from `sqrbot-jr`.
|
|
64
|
+
|
|
65
|
+
- Removed the pre-commit hook for prettier and now run prettier directly from the tox lint environment. This change is necessary because the prettier hook for pre-commit is no longer supported.
|
|
66
|
+
|
|
67
|
+
- Adopted [ts-graphviz/setup-graphviz](https://github.com/ts-graphviz/setup-graphviz) for installing Graphviz in GitHub Actions CI workflows.
|
|
68
|
+
|
|
69
|
+
- Updated how license information is encoded in `pyproject.toml`.
|
|
70
|
+
|
|
71
|
+
- Switched to dependency groups for development dependencies in `pyproject.toml`. With this change, Documenteer no longer publishes a `dev` extra to PyPI.
|
|
72
|
+
|
|
73
|
+
- Documenteer no longer depends on setuptools as a runtime dependency thanks to pybtex version 0.25 and `documenteer.ext.redoc`.
|
|
74
|
+
|
|
5
75
|
<a id='changelog-1.4.5'></a>
|
|
6
76
|
## 1.4.5 (2025-06-25)
|
|
7
77
|
|
|
@@ -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,90 +1,66 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version:
|
|
3
|
+
Version: 2.0.0
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License-Expression: MIT
|
|
6
6
|
Project-URL: Homepage, https://documenteer.lsst.io
|
|
7
7
|
Project-URL: Source, https://github.com/lsst-sqre/documenteer
|
|
8
8
|
Keywords: rubin,lsst
|
|
9
|
-
Classifier: Development Status ::
|
|
9
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
10
|
+
Classifier: Environment :: Console
|
|
11
|
+
Classifier: Framework :: Sphinx :: Extension
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Natural Language :: English
|
|
14
|
+
Classifier: Operating System :: POSIX
|
|
10
15
|
Classifier: Programming Language :: Python
|
|
11
16
|
Classifier: Programming Language :: Python :: 3
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.
|
|
13
|
-
Classifier:
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
19
|
Classifier: Topic :: Documentation
|
|
15
20
|
Classifier: Topic :: Documentation :: Sphinx
|
|
16
|
-
Classifier:
|
|
17
|
-
|
|
18
|
-
Classifier: Natural Language :: English
|
|
19
|
-
Classifier: Operating System :: POSIX
|
|
20
|
-
Requires-Python: >=3.11
|
|
21
|
+
Classifier: Typing :: Typed
|
|
22
|
+
Requires-Python: >=3.12
|
|
21
23
|
Description-Content-Type: text/markdown
|
|
22
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
|
|
23
30
|
Requires-Dist: docutils>=0.20
|
|
24
31
|
Requires-Dist: Sphinx<8.2,>=7
|
|
25
32
|
Requires-Dist: PyYAML
|
|
26
33
|
Requires-Dist: GitPython
|
|
27
34
|
Requires-Dist: requests
|
|
28
35
|
Requires-Dist: click
|
|
29
|
-
Requires-Dist: sphinxcontrib-bibtex>=2.
|
|
30
|
-
Requires-Dist:
|
|
36
|
+
Requires-Dist: sphinxcontrib-bibtex>=2.6.5
|
|
37
|
+
Requires-Dist: pybtex>=0.25.0
|
|
31
38
|
Requires-Dist: pydantic>=2.0.0
|
|
32
39
|
Requires-Dist: urllib3
|
|
33
40
|
Requires-Dist: pylatexenc
|
|
34
41
|
Requires-Dist: tomlkit
|
|
35
|
-
Provides-Extra: dev
|
|
36
|
-
Requires-Dist: twine; extra == "dev"
|
|
37
|
-
Requires-Dist: coverage[toml]; extra == "dev"
|
|
38
|
-
Requires-Dist: pytest; extra == "dev"
|
|
39
|
-
Requires-Dist: pytest-mock; extra == "dev"
|
|
40
|
-
Requires-Dist: lxml; extra == "dev"
|
|
41
|
-
Requires-Dist: cssselect; extra == "dev"
|
|
42
|
-
Requires-Dist: defusedxml; extra == "dev"
|
|
43
|
-
Requires-Dist: sphinx-click; extra == "dev"
|
|
44
|
-
Requires-Dist: sphinxcontrib-autoprogram; extra == "dev"
|
|
45
|
-
Requires-Dist: types-setuptools; extra == "dev"
|
|
46
|
-
Requires-Dist: types-requests; extra == "dev"
|
|
47
|
-
Requires-Dist: types-PyYAML; extra == "dev"
|
|
48
|
-
Requires-Dist: types-docutils; extra == "dev"
|
|
49
|
-
Requires-Dist: types-mock; extra == "dev"
|
|
50
42
|
Provides-Extra: guide
|
|
43
|
+
Requires-Dist: autodoc_pydantic; extra == "guide"
|
|
51
44
|
Requires-Dist: sphinx_design; extra == "guide"
|
|
52
|
-
Requires-Dist: pydata-sphinx-theme<0.
|
|
45
|
+
Requires-Dist: pydata-sphinx-theme<0.17.0,>=0.16.1; extra == "guide"
|
|
53
46
|
Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
|
|
54
47
|
Requires-Dist: sphinx-automodapi; extra == "guide"
|
|
55
48
|
Requires-Dist: sphinx-copybutton; extra == "guide"
|
|
56
|
-
Requires-Dist: sphinx-prompt
|
|
49
|
+
Requires-Dist: sphinx-prompt; extra == "guide"
|
|
57
50
|
Requires-Dist: sphinx-jinja>=2; extra == "guide"
|
|
58
51
|
Requires-Dist: myst-parser; extra == "guide"
|
|
59
52
|
Requires-Dist: myst-nb; extra == "guide"
|
|
60
53
|
Requires-Dist: markdown-it-py[linkify]; extra == "guide"
|
|
61
54
|
Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
|
|
62
55
|
Requires-Dist: sphinxext-opengraph; extra == "guide"
|
|
63
|
-
Requires-Dist: sphinxcontrib-redoc; extra == "guide"
|
|
64
56
|
Requires-Dist: sphinxcontrib-jquery; extra == "guide"
|
|
65
57
|
Requires-Dist: sphinxext-rediraffe; extra == "guide"
|
|
66
58
|
Requires-Dist: sphinxcontrib-youtube; extra == "guide"
|
|
67
|
-
|
|
68
|
-
Requires-Dist: sphinx_design; extra == "pipelines"
|
|
69
|
-
Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
|
|
70
|
-
Requires-Dist: sphinx-autodoc-typehints; extra == "pipelines"
|
|
71
|
-
Requires-Dist: sphinx-automodapi; extra == "pipelines"
|
|
72
|
-
Requires-Dist: sphinx-copybutton; extra == "pipelines"
|
|
73
|
-
Requires-Dist: sphinx-prompt<2,>=1.10.0; extra == "pipelines"
|
|
74
|
-
Requires-Dist: sphinx-jinja>=2; extra == "pipelines"
|
|
75
|
-
Requires-Dist: myst-parser; extra == "pipelines"
|
|
76
|
-
Requires-Dist: markdown-it-py[linkify]; extra == "pipelines"
|
|
77
|
-
Requires-Dist: sphinxcontrib-mermaid; extra == "pipelines"
|
|
78
|
-
Requires-Dist: sphinxext-opengraph; extra == "pipelines"
|
|
79
|
-
Requires-Dist: sphinxcontrib-redoc; extra == "pipelines"
|
|
80
|
-
Requires-Dist: sphinxcontrib-jquery; extra == "pipelines"
|
|
81
|
-
Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
|
|
82
|
-
Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
|
|
83
|
-
Requires-Dist: sphinx-click; extra == "pipelines"
|
|
59
|
+
Requires-Dist: sphinx-favicon; extra == "guide"
|
|
84
60
|
Provides-Extra: technote
|
|
85
61
|
Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
|
|
86
|
-
Requires-Dist: sphinx-prompt
|
|
87
|
-
Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
|
|
62
|
+
Requires-Dist: sphinx-prompt; extra == "technote"
|
|
63
|
+
Requires-Dist: sphinxcontrib-mermaid>=1; extra == "technote"
|
|
88
64
|
Requires-Dist: sphinx-diagrams; extra == "technote"
|
|
89
65
|
Requires-Dist: sphinx_design; extra == "technote"
|
|
90
66
|
Requires-Dist: myst-nb; extra == "technote"
|
|
@@ -93,14 +69,14 @@ Dynamic: license-file
|
|
|
93
69
|
|
|
94
70
|
[](https://documenteer.lsst.io)
|
|
95
71
|
[](https://pypi.python.org/pypi/documenteer)
|
|
96
|
-
[](https://pypi.python.org/pypi/documenteer)
|
|
97
73
|
[](https://pypi.python.org/pypi/documenteer)
|
|
98
74
|
[](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
|
|
99
75
|
[](https://github.com/lsst-sqre/documenteer/actions/workflows/ci-cron.yaml)
|
|
100
76
|
|
|
101
77
|
# Documenteer
|
|
102
78
|
|
|
103
|
-
Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, [user guides](https://documenteer.lsst.io/guides/index.html)
|
|
79
|
+
Documenteer provides tools, extensions, and configurations for Rubin Observatory's Sphinx documentation projects, including [user guides](https://documenteer.lsst.io/guides/index.html) and [technotes](https://developer.lsst.io/project-docs/technotes.html).
|
|
104
80
|
|
|
105
81
|
For more information about Documenteer, see the documentation at https://documenteer.lsst.io.
|
|
106
82
|
|
|
@@ -119,9 +95,3 @@ For [technical note projects](https://documenteer.lsst.io/technotes/index.html):
|
|
|
119
95
|
```sh
|
|
120
96
|
pip install "documenteer[technote]"
|
|
121
97
|
```
|
|
122
|
-
|
|
123
|
-
For the [stack projects](https://documenteer.lsst.io/pipelines/index.html) (such as the [LSST Science Pipelines](https://pipelines.lsst.io)):
|
|
124
|
-
|
|
125
|
-
```sh
|
|
126
|
-
pip install "documenteer[pipelines]"
|
|
127
|
-
```
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
[](https://documenteer.lsst.io)
|
|
2
2
|
[](https://pypi.python.org/pypi/documenteer)
|
|
3
|
-
[](https://pypi.python.org/pypi/documenteer)
|
|
4
4
|
[](https://pypi.python.org/pypi/documenteer)
|
|
5
5
|
[](https://github.com/lsst-sqre/documenteer/actions/workflows/ci.yaml)
|
|
6
6
|
[](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)
|
|
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
|
-
```
|