documenteer 1.4.3__tar.gz → 2.0.0a2__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-1.4.3 → documenteer-2.0.0a2}/.github/SUPPORT.md +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.github/workflows/ci-cron.yaml +6 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.github/workflows/ci.yaml +12 -28
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.pre-commit-config.yaml +13 -17
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.prettierignore +0 -2
- documenteer-2.0.0a2/.vscode/settings.json +4 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/CHANGELOG.md +0 -25
- {documenteer-1.4.3/src/documenteer.egg-info → documenteer-2.0.0a2}/PKG-INFO +13 -27
- documenteer-2.0.0a2/changelog.d/20240819_152413_jsick_DM_45803.md +33 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/Makefile +1 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/_rst_epilog.rst +1 -6
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/changelog.md +0 -25
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/api/documenteer.ext.rst +0 -7
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/api/index.rst +0 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/documenteer.toml +10 -8
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/index.rst +0 -8
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/page-redirects.rst +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/index.rst +1 -15
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/index.rst +0 -10
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/migrate.rst +4 -4
- {documenteer-1.4.3 → documenteer-2.0.0a2}/package-lock.json +0 -22
- {documenteer-1.4.3 → documenteer-2.0.0a2}/package.json +0 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/pyproject.toml +70 -41
- documenteer-2.0.0a2/ruff-shared.toml +139 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/_properties.scss +3 -3
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-pydata-theme.css +2 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-technote.css +3 -3
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-technote.css.map +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/cli.py +1 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/conf/_toml.py +45 -55
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/conf/_utils.py +4 -7
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/conf/guide.py +62 -16
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/conf/technote.py +5 -11
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/bibtex.py +4 -2
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/githubbibcache.py +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/jira.py +49 -35
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/lsstdocushare.py +17 -16
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/mockcoderefs.py +16 -4
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/openapi.py +6 -6
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/remotecodeblock.py +24 -28
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/packagemetadata.py +8 -22
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/requestsutils.py +8 -7
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/services/technoteauthor.py +6 -4
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/services/technotemigration.py +21 -14
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/authordb.py +2 -7
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/conf.py +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates.py +1 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/technotetoml.py +3 -6
- documenteer-2.0.0a2/src/documenteer/templates/pydata/autosummary_core/exception.rst +15 -0
- documenteer-2.0.0a2/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +11 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/utils.py +11 -13
- {documenteer-1.4.3 → documenteer-2.0.0a2/src/documenteer.egg-info}/PKG-INFO +13 -27
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer.egg-info/SOURCES.txt +5 -49
- documenteer-2.0.0a2/src/documenteer.egg-info/entry_points.txt +2 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer.egg-info/requires.txt +3 -20
- documenteer-2.0.0a2/tests/conftest.py +24 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/ext/jira_test.py +6 -5
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/ext/lsstdocushare_test.py +7 -5
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/ext/mockcoderefs_test.py +13 -11
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/storage/technotetoml_test.py +0 -1
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/test_conf_toml.py +3 -5
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tox.ini +13 -11
- documenteer-1.4.3/.github/workflows/dependencies.yaml +0 -33
- documenteer-1.4.3/.vscode/settings.json +0 -6
- documenteer-1.4.3/docs/dev/api/documenteer.sphinxrunner.rst +0 -6
- documenteer-1.4.3/docs/dev/api/documenteer.stackdocs.rst +0 -21
- documenteer-1.4.3/docs/guides/pipelines/build-overview.rst +0 -112
- documenteer-1.4.3/docs/guides/pipelines/configuration.rst +0 -84
- documenteer-1.4.3/docs/guides/pipelines/cpp-api-linking.rst +0 -116
- documenteer-1.4.3/docs/guides/pipelines/index.rst +0 -17
- documenteer-1.4.3/docs/guides/pipelines/install.rst +0 -45
- documenteer-1.4.3/docs/guides/pipelines/package-docs-cli.rst +0 -15
- documenteer-1.4.3/docs/guides/pipelines/stack-docs-cli.rst +0 -15
- documenteer-1.4.3/docs/sphinx-extensions/autocppapi.rst +0 -69
- documenteer-1.4.3/docs/sphinx-extensions/autodocreset.rst +0 -22
- documenteer-1.4.3/docs/sphinx-extensions/lssttasks.rst +0 -376
- documenteer-1.4.3/docs/sphinx-extensions/package-toctree.rst +0 -76
- documenteer-1.4.3/src/documenteer/conf/pipelines.py +0 -224
- documenteer-1.4.3/src/documenteer/conf/pipelinespkg.py +0 -15
- documenteer-1.4.3/src/documenteer/ext/_utils.py +0 -210
- documenteer-1.4.3/src/documenteer/ext/autocppapi.py +0 -307
- documenteer-1.4.3/src/documenteer/ext/autodocreset.py +0 -26
- documenteer-1.4.3/src/documenteer/ext/lssttasks/__init__.py +0 -84
- documenteer-1.4.3/src/documenteer/ext/lssttasks/configfieldlists.py +0 -1179
- documenteer-1.4.3/src/documenteer/ext/lssttasks/crossrefs.py +0 -397
- documenteer-1.4.3/src/documenteer/ext/lssttasks/pyapisummary.py +0 -320
- documenteer-1.4.3/src/documenteer/ext/lssttasks/taskutils.py +0 -221
- documenteer-1.4.3/src/documenteer/ext/lssttasks/topiclists.py +0 -276
- documenteer-1.4.3/src/documenteer/ext/lssttasks/topics.py +0 -169
- documenteer-1.4.3/src/documenteer/ext/packagetoctree.py +0 -245
- documenteer-1.4.3/src/documenteer/sphinxrunner.py +0 -69
- documenteer-1.4.3/src/documenteer/stackdocs/build.py +0 -307
- documenteer-1.4.3/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -35489
- documenteer-1.4.3/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -2414
- documenteer-1.4.3/src/documenteer/stackdocs/data/mainpage.dox +0 -9
- documenteer-1.4.3/src/documenteer/stackdocs/doxygen.py +0 -732
- documenteer-1.4.3/src/documenteer/stackdocs/doxygentag.py +0 -59
- documenteer-1.4.3/src/documenteer/stackdocs/packagecli.py +0 -142
- documenteer-1.4.3/src/documenteer/stackdocs/pkgdiscovery.py +0 -308
- documenteer-1.4.3/src/documenteer/stackdocs/rootdiscovery.py +0 -118
- documenteer-1.4.3/src/documenteer/stackdocs/stackcli.py +0 -342
- documenteer-1.4.3/src/documenteer.egg-info/entry_points.txt +0 -4
- documenteer-1.4.3/tests/conftest.py +0 -21
- documenteer-1.4.3/tests/ext/autocppapi_test.py +0 -38
- documenteer-1.4.3/tests/ext/lssttasks/taskutils_test.py +0 -32
- documenteer-1.4.3/tests/ext/packagetoctree_test.py +0 -20
- documenteer-1.4.3/tests/ext/utils_test.py +0 -25
- documenteer-1.4.3/tests/storage/__init__.py +0 -0
- documenteer-1.4.3/tests/test_stackdocs_build.py +0 -77
- documenteer-1.4.3/tests/test_stackdocs_doxygen.py +0 -168
- documenteer-1.4.3/tests/test_stackdocs_doxygentag.py +0 -48
- documenteer-1.4.3/tests/test_stackdocs_pkgdiscovery.py +0 -65
- documenteer-1.4.3/tests/test_stackdocs_rootdiscovery.py +0 -117
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.flake8 +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.github/CODE_OF_CONDUCT.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.github/CONTRIBUTING.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.github/dependabot.yml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.npmrc +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.nvmrc +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.prettierrc.yaml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/.vscode/tasks.json +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/LICENSE +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/MANIFEST.in +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/Makefile +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/changelog.d/_template.md.jinja +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/Makefile +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/conf.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/diagram.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/index.ipynb +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/ipynb-technote/technote.toml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/Makefile +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/conf.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/diagram.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/index.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/md-technote/technote.toml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/Makefile +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/conf.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/diagram.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/index.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/demo/rst-technote/technote.toml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/conf.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/api/documenteer.conf.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/api/documenteer.requestsutils.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/development.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/html-templates.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/index.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/release.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/theme-assets.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/dev/theme.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/badges.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/configuration-preset.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/configuration.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/diagrams.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/extend-conf-py.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/including-notebooks.ipynb +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/markdown-primer.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/openapi.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/organization.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/overview.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/pyproject-configuration.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/rst-epilog.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/tabsets.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/toml-reference.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/guides/video-embeds.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/docushare-reference.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/githubbibcache.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/jira-reference.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/openapi.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/sphinx-extensions/remote-code-block.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/_templates/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/_templates/README.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/author-metadata.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/configuration.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/document-status.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/edit-locally.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/edit-on-github.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/extensions.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/how-your-technote-gets-published.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/index.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/start-a-technote.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/docs/technotes/wide-content.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/licenses/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/licenses/astropy-helpers.txt +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/licenses/sphinx-issue.txt +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/licenses/sphinx.txt +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/postcss.config.js +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/setup.cfg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/.gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/favicon.ico +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-favicon.svg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/conf/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/ext/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/py.typed +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/services/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/latex.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/pydata/layout.html +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/.gitkeep +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/components/.gitkeep +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/sections/header-article.html +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer/version.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer.egg-info/dependency_links.txt +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/src/documenteer.egg-info/top_level.txt +0 -0
- {documenteer-1.4.3/src/documenteer/stackdocs → documenteer-2.0.0a2/tests}/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/afw.doxygen.conf +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/authordb.yaml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/doxygen.tag.zip +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/doc/manifest.yaml +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/include/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_alpha/src/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/data/package_beta/doc/README.md +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/ext/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/packagemetadata_test.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/roots/test-autocppapi/conf.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/roots/test-autocppapi/index.rst +0 -0
- {documenteer-1.4.3/tests/ext/lssttasks → documenteer-2.0.0a2/tests/services}/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/services/technotemigration_test.py +0 -0
- {documenteer-1.4.3/tests/services → documenteer-2.0.0a2/tests/storage}/__init__.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/storage/authordb_test.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/tests/test_conf_utils.py +0 -0
- {documenteer-1.4.3 → documenteer-2.0.0a2}/webpack.config.js +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
Here are some ways to get help with Documenteer:
|
|
2
2
|
|
|
3
3
|
- [Documentation](https://documenteer.lsst.io)
|
|
4
|
-
- [Ask a question in #
|
|
4
|
+
- [Ask a question in #dm-docs-support (for Rubin staff)](https://lsstc.slack.com/archives/C2B6DQBAL)
|
|
5
5
|
- [Post a GitHub issue](https://github.com/lsst-sqre/documenteer/issues/new)
|
|
@@ -4,6 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
name: Periodic CI
|
|
6
6
|
|
|
7
|
+
env:
|
|
8
|
+
PYTHON_VERSION: "3.12"
|
|
9
|
+
|
|
7
10
|
"on":
|
|
8
11
|
schedule:
|
|
9
12
|
- cron: "0 12 * * 1"
|
|
@@ -19,6 +22,7 @@ jobs:
|
|
|
19
22
|
- "3.12"
|
|
20
23
|
sphinx-version:
|
|
21
24
|
- "7"
|
|
25
|
+
- "8"
|
|
22
26
|
- "dev"
|
|
23
27
|
|
|
24
28
|
steps:
|
|
@@ -64,7 +68,7 @@ jobs:
|
|
|
64
68
|
- name: Build docs in tox
|
|
65
69
|
uses: lsst-sqre/run-tox@v1
|
|
66
70
|
with:
|
|
67
|
-
python-version:
|
|
71
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
68
72
|
tox-envs: "docs,docs-lint"
|
|
69
73
|
use-cache: false
|
|
70
74
|
|
|
@@ -94,5 +98,5 @@ jobs:
|
|
|
94
98
|
- name: Build and publish
|
|
95
99
|
uses: lsst-sqre/build-and-publish-to-pypi@v2
|
|
96
100
|
with:
|
|
97
|
-
python-version:
|
|
101
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
98
102
|
upload: false
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
name: CI
|
|
2
2
|
|
|
3
|
+
env:
|
|
4
|
+
PYTHON_VERSION: '3.12' # Default Python version
|
|
5
|
+
|
|
3
6
|
'on':
|
|
4
7
|
push:
|
|
5
8
|
branches-ignore:
|
|
@@ -26,27 +29,8 @@ jobs:
|
|
|
26
29
|
with:
|
|
27
30
|
python-version: '3.12'
|
|
28
31
|
|
|
29
|
-
-
|
|
30
|
-
|
|
31
|
-
cache: 'npm'
|
|
32
|
-
node-version-file: '.nvmrc'
|
|
33
|
-
|
|
34
|
-
- name: Authenticate GitHub Packages
|
|
35
|
-
run: |
|
|
36
|
-
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
37
|
-
env:
|
|
38
|
-
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
39
|
-
|
|
40
|
-
- name: npm install and build
|
|
41
|
-
run: |
|
|
42
|
-
npm install
|
|
43
|
-
npm run build
|
|
44
|
-
|
|
45
|
-
- name: Run tox
|
|
46
|
-
uses: lsst-sqre/run-tox@v1
|
|
47
|
-
with:
|
|
48
|
-
python-version: '3.12'
|
|
49
|
-
tox-envs: 'lint'
|
|
32
|
+
- name: Run pre-commit
|
|
33
|
+
uses: pre-commit/action@v3.0.1
|
|
50
34
|
|
|
51
35
|
test:
|
|
52
36
|
runs-on: ubuntu-latest
|
|
@@ -58,6 +42,7 @@ jobs:
|
|
|
58
42
|
- '3.12'
|
|
59
43
|
sphinx-version:
|
|
60
44
|
- '7'
|
|
45
|
+
- '8'
|
|
61
46
|
|
|
62
47
|
steps:
|
|
63
48
|
- uses: actions/checkout@v4
|
|
@@ -89,13 +74,13 @@ jobs:
|
|
|
89
74
|
uses: lsst-sqre/run-tox@v1
|
|
90
75
|
with:
|
|
91
76
|
python-version: ${{ matrix.python-version }}
|
|
92
|
-
tox-envs: '
|
|
77
|
+
tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
|
|
93
78
|
|
|
94
79
|
docs:
|
|
95
80
|
runs-on: ubuntu-latest
|
|
96
81
|
|
|
97
82
|
steps:
|
|
98
|
-
- uses: actions/checkout@
|
|
83
|
+
- uses: actions/checkout@v4
|
|
99
84
|
with:
|
|
100
85
|
fetch-depth: 0 # full history for setuptools_scm
|
|
101
86
|
|
|
@@ -105,7 +90,7 @@ jobs:
|
|
|
105
90
|
- name: Run tox
|
|
106
91
|
uses: lsst-sqre/run-tox@v1
|
|
107
92
|
with:
|
|
108
|
-
python-version:
|
|
93
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
109
94
|
tox-envs: 'docs,docs-lint'
|
|
110
95
|
|
|
111
96
|
# Only attempt documentation uploads for tagged releases and pull
|
|
@@ -122,7 +107,6 @@ jobs:
|
|
|
122
107
|
if: >
|
|
123
108
|
github.event_name != 'pull_request' || startsWith(github.head_ref, 'tickets/')
|
|
124
109
|
|
|
125
|
-
|
|
126
110
|
test-package:
|
|
127
111
|
name: Test PyPI package build
|
|
128
112
|
runs-on: ubuntu-latest
|
|
@@ -135,8 +119,8 @@ jobs:
|
|
|
135
119
|
- name: Build and publish
|
|
136
120
|
uses: lsst-sqre/build-and-publish-to-pypi@v2
|
|
137
121
|
with:
|
|
138
|
-
python-version:
|
|
139
|
-
upload:
|
|
122
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
123
|
+
upload: "false"
|
|
140
124
|
|
|
141
125
|
pypi-publish:
|
|
142
126
|
name: Upload release to PyPI
|
|
@@ -167,4 +151,4 @@ jobs:
|
|
|
167
151
|
- name: Build and publish
|
|
168
152
|
uses: lsst-sqre/build-and-publish-to-pypi@v2
|
|
169
153
|
with:
|
|
170
|
-
python-version:
|
|
154
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
@@ -14,26 +14,22 @@ 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,
|
|
28
|
+
additional_dependencies: [black==24.4.2]
|
|
29
|
+
args: [-l, '79', -t, py312]
|
|
35
30
|
|
|
36
|
-
- repo: https://github.com/
|
|
37
|
-
rev:
|
|
31
|
+
- repo: https://github.com/pre-commit/mirrors-prettier
|
|
32
|
+
rev: v4.0.0-alpha.8
|
|
38
33
|
hooks:
|
|
39
|
-
- id:
|
|
34
|
+
- id: prettier
|
|
35
|
+
types_or: [css, scss, javascript]
|
|
@@ -2,31 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- scriv-insert-here -->
|
|
4
4
|
|
|
5
|
-
<a id='changelog-1.4.3'></a>
|
|
6
|
-
## 1.4.3 (2025-02-19)
|
|
7
|
-
|
|
8
|
-
### Bug fixes
|
|
9
|
-
|
|
10
|
-
- Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
|
|
11
|
-
|
|
12
|
-
### Other changes
|
|
13
|
-
|
|
14
|
-
- Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
|
|
15
|
-
|
|
16
|
-
<a id='changelog-1.4.2'></a>
|
|
17
|
-
## 1.4.2 (2024-10-15)
|
|
18
|
-
|
|
19
|
-
### Bug fixes
|
|
20
|
-
|
|
21
|
-
- Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
|
|
22
|
-
|
|
23
|
-
<a id='changelog-1.4.1'></a>
|
|
24
|
-
## 1.4.1 (2024-10-10)
|
|
25
|
-
|
|
26
|
-
### Bug fixes
|
|
27
|
-
|
|
28
|
-
- Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
|
|
29
|
-
|
|
30
5
|
<a id='changelog-1.4.0'></a>
|
|
31
6
|
## 1.4.0 (2024-07-11)
|
|
32
7
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version:
|
|
3
|
+
Version: 2.0.0a2
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License: The MIT License (MIT)
|
|
6
6
|
|
|
@@ -27,23 +27,25 @@ License: The MIT License (MIT)
|
|
|
27
27
|
Project-URL: Homepage, https://documenteer.lsst.io
|
|
28
28
|
Project-URL: Source, https://github.com/lsst-sqre/documenteer
|
|
29
29
|
Keywords: rubin,lsst
|
|
30
|
-
Classifier: Development Status ::
|
|
30
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
31
|
+
Classifier: Environment :: Console
|
|
32
|
+
Classifier: Framework :: Sphinx :: Extension
|
|
33
|
+
Classifier: Intended Audience :: Developers
|
|
31
34
|
Classifier: License :: OSI Approved :: MIT License
|
|
35
|
+
Classifier: Natural Language :: English
|
|
36
|
+
Classifier: Operating System :: POSIX
|
|
32
37
|
Classifier: Programming Language :: Python
|
|
33
38
|
Classifier: Programming Language :: Python :: 3
|
|
34
39
|
Classifier: Programming Language :: Python :: 3.11
|
|
35
|
-
Classifier:
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
36
41
|
Classifier: Topic :: Documentation
|
|
37
42
|
Classifier: Topic :: Documentation :: Sphinx
|
|
38
|
-
Classifier:
|
|
39
|
-
Classifier: Environment :: Console
|
|
40
|
-
Classifier: Natural Language :: English
|
|
41
|
-
Classifier: Operating System :: POSIX
|
|
43
|
+
Classifier: Typing :: Typed
|
|
42
44
|
Requires-Python: >=3.11
|
|
43
45
|
Description-Content-Type: text/markdown
|
|
44
46
|
License-File: LICENSE
|
|
45
47
|
Requires-Dist: docutils>=0.20
|
|
46
|
-
Requires-Dist: Sphinx
|
|
48
|
+
Requires-Dist: Sphinx>=7
|
|
47
49
|
Requires-Dist: PyYAML
|
|
48
50
|
Requires-Dist: GitPython
|
|
49
51
|
Requires-Dist: requests
|
|
@@ -70,6 +72,7 @@ Requires-Dist: types-PyYAML; extra == "dev"
|
|
|
70
72
|
Requires-Dist: types-docutils; extra == "dev"
|
|
71
73
|
Requires-Dist: types-mock; extra == "dev"
|
|
72
74
|
Provides-Extra: guide
|
|
75
|
+
Requires-Dist: autodoc_pydantic; extra == "guide"
|
|
73
76
|
Requires-Dist: sphinx_design; extra == "guide"
|
|
74
77
|
Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "guide"
|
|
75
78
|
Requires-Dist: sphinx-autodoc-typehints; extra == "guide"
|
|
@@ -80,29 +83,12 @@ Requires-Dist: sphinx-jinja>=2; extra == "guide"
|
|
|
80
83
|
Requires-Dist: myst-parser; extra == "guide"
|
|
81
84
|
Requires-Dist: myst-nb; extra == "guide"
|
|
82
85
|
Requires-Dist: markdown-it-py[linkify]; extra == "guide"
|
|
83
|
-
Requires-Dist: sphinxcontrib-mermaid
|
|
86
|
+
Requires-Dist: sphinxcontrib-mermaid; extra == "guide"
|
|
84
87
|
Requires-Dist: sphinxext-opengraph; extra == "guide"
|
|
85
88
|
Requires-Dist: sphinxcontrib-redoc; extra == "guide"
|
|
86
89
|
Requires-Dist: sphinxcontrib-jquery; extra == "guide"
|
|
87
90
|
Requires-Dist: sphinxext-rediraffe; extra == "guide"
|
|
88
91
|
Requires-Dist: sphinxcontrib-youtube; extra == "guide"
|
|
89
|
-
Provides-Extra: pipelines
|
|
90
|
-
Requires-Dist: sphinx_design; extra == "pipelines"
|
|
91
|
-
Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
|
|
92
|
-
Requires-Dist: sphinx-autodoc-typehints; extra == "pipelines"
|
|
93
|
-
Requires-Dist: sphinx-automodapi; extra == "pipelines"
|
|
94
|
-
Requires-Dist: sphinx-copybutton; extra == "pipelines"
|
|
95
|
-
Requires-Dist: sphinx-prompt; extra == "pipelines"
|
|
96
|
-
Requires-Dist: sphinx-jinja>=2; extra == "pipelines"
|
|
97
|
-
Requires-Dist: myst-parser; extra == "pipelines"
|
|
98
|
-
Requires-Dist: markdown-it-py[linkify]; extra == "pipelines"
|
|
99
|
-
Requires-Dist: sphinxcontrib-mermaid; extra == "pipelines"
|
|
100
|
-
Requires-Dist: sphinxext-opengraph; extra == "pipelines"
|
|
101
|
-
Requires-Dist: sphinxcontrib-redoc; extra == "pipelines"
|
|
102
|
-
Requires-Dist: sphinxcontrib-jquery; extra == "pipelines"
|
|
103
|
-
Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
|
|
104
|
-
Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
|
|
105
|
-
Requires-Dist: sphinx-click; extra == "pipelines"
|
|
106
92
|
Provides-Extra: technote
|
|
107
93
|
Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
|
|
108
94
|
Requires-Dist: sphinx-prompt; extra == "technote"
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
### Backwards-incompatible changes
|
|
2
|
+
|
|
3
|
+
- All Science Pipelines-related tooling and Sphinx extensions have been removed from Documenteer, and can now be found in a new Science Pipelines package called `sphinxutils` (https://github.com/lsst-dm/sphinxutils). Specific removals include:
|
|
4
|
+
|
|
5
|
+
- `documenteer.stackdocs`
|
|
6
|
+
- Configurations `documenteer.conf.pipelines` and `documenteer.conf.pipelinespkg`
|
|
7
|
+
- CLI commands `stack-docs` and `package-docs`
|
|
8
|
+
- Sphinx extensions:
|
|
9
|
+
- `documenteer.ext.lssttasks`
|
|
10
|
+
- `documenteer.ext.packagetoctree`
|
|
11
|
+
- `documenteer.ext.autocppapi`
|
|
12
|
+
- `documenteer.ext.autodocreset`
|
|
13
|
+
|
|
14
|
+
### New features
|
|
15
|
+
|
|
16
|
+
- User guide configuration improvements:
|
|
17
|
+
|
|
18
|
+
- New custom automodapi templates for Pydantic BaseModels and exceptions. The exception template ensures that inherited members of exceptions are documented. The Pydantic BaseModel template ensures that inherited members from the `BaseModel` class itself are _not_ documented. These templates were originally developed as part of [Gafaelfawr](https://github.com/lsst-sqre/gafaelfawr). Now users of the user guide configuration benefit from these templates without any additional configuration.
|
|
19
|
+
|
|
20
|
+
- The `[guide]` installation extra and `documenteer.conf.guide` configuration now include `autodoc_pydantic` for improved documentation of Pydantic models in Python API references.
|
|
21
|
+
|
|
22
|
+
- The `documenteer.conf.guide` configuration now ignores common Sphinx warnings that are common when including references to projects that don't use Sphinx/Intersphinx for this documentation, including Pydantic and FastAPI.
|
|
23
|
+
|
|
24
|
+
- The entire `documenteer` code base is now type annotated.
|
|
25
|
+
|
|
26
|
+
### Bug fixes
|
|
27
|
+
|
|
28
|
+
-
|
|
29
|
+
|
|
30
|
+
### Other changes
|
|
31
|
+
|
|
32
|
+
- The code base is now linted and formatted with ruff.
|
|
33
|
+
- Start testing against Sphinx 8.
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
.. _sphinxcontrib-mermaid: https://github.com/mgaitan/sphinxcontrib-mermaid
|
|
14
14
|
.. _Diagrams: https://diagrams.mingrammer.com/
|
|
15
15
|
.. _sphinx-diagrams: https://github.com/j-martin/sphinx-diagrams
|
|
16
|
-
.. _`#
|
|
16
|
+
.. _`#dm-docs-support`: https://lsstc.slack.com/archives/C2B6DQBAL
|
|
17
17
|
.. _`DMTN-030`:
|
|
18
18
|
.. _`DMTN-030 Science Pipelines Documentation Design`: https://dmtn-030.lsst.io
|
|
19
19
|
.. _`Google Developer Style Guide`: https://developers.google.com/style/
|
|
@@ -27,7 +27,6 @@
|
|
|
27
27
|
.. _TOML: https://toml.io/en/
|
|
28
28
|
.. _`SQR-006`: https://sqr-006.lsst.io
|
|
29
29
|
.. _`lsstDoxygen`: https://github.com/lsst/lsstDoxygen
|
|
30
|
-
.. _`package-docs`: https://documenteer.lsst.io/pipelines/package-docs-cli.html
|
|
31
30
|
.. _`pex_config`: https://github.com/lsst/pex_config
|
|
32
31
|
.. _`pipe_base`: https://github.com/lsst/pipe_base
|
|
33
32
|
.. _`pipe_supertask`: https://github.com/lsst/pipe_supertask
|
|
@@ -70,10 +69,6 @@
|
|
|
70
69
|
|
|
71
70
|
.. |documenteer.toml| replace:: :doc:`documenteer.toml </guides/toml-reference>`
|
|
72
71
|
.. |documenteer.conf.guide| replace:: :doc:`documenteer.conf.guide </guides/configuration-preset>`
|
|
73
|
-
.. |package-docs| replace:: :doc:`package-docs </guides/pipelines/package-docs-cli>`
|
|
74
|
-
.. |stack-docs| replace:: :doc:`stack-docs </guides/pipelines/stack-docs-cli>`
|
|
75
|
-
.. |stack-docs-build| replace:: :doc:`stack-docs build </guides/pipelines/stack-docs-cli>`
|
|
76
|
-
.. |stack-docs-clean| replace:: :doc:`stack-docs clean </guides/pipelines/stack-docs-cli>`
|
|
77
72
|
|
|
78
73
|
.. links to sphinx directives
|
|
79
74
|
|
|
@@ -2,31 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- scriv-insert-here -->
|
|
4
4
|
|
|
5
|
-
<a id='changelog-1.4.3'></a>
|
|
6
|
-
## 1.4.3 (2025-02-19)
|
|
7
|
-
|
|
8
|
-
### Bug fixes
|
|
9
|
-
|
|
10
|
-
- Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
|
|
11
|
-
|
|
12
|
-
### Other changes
|
|
13
|
-
|
|
14
|
-
- Prettier is now run directly through the tox lint environment rather than through pre-commit since the pre-commit plugin is deprecated and no longer operable.
|
|
15
|
-
|
|
16
|
-
<a id='changelog-1.4.2'></a>
|
|
17
|
-
## 1.4.2 (2024-10-15)
|
|
18
|
-
|
|
19
|
-
### Bug fixes
|
|
20
|
-
|
|
21
|
-
- Pin `sphinxcontrib-mermaid` to >= 1 to address an incompatibility with Sphinx==8.1.0. Also unpin the version of Mermaid itself.
|
|
22
|
-
|
|
23
|
-
<a id='changelog-1.4.1'></a>
|
|
24
|
-
## 1.4.1 (2024-10-10)
|
|
25
|
-
|
|
26
|
-
### Bug fixes
|
|
27
|
-
|
|
28
|
-
- Pin Sphinx to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.
|
|
29
|
-
|
|
30
5
|
<a id='changelog-1.4.0'></a>
|
|
31
6
|
## 1.4.0 (2024-07-11)
|
|
32
7
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
documenteer.ext
|
|
3
3
|
###############
|
|
4
4
|
|
|
5
|
-
.. automodapi:: documenteer.ext.autocppapi
|
|
6
|
-
|
|
7
|
-
.. automodapi:: documenteer.ext.autodocreset
|
|
8
|
-
|
|
9
5
|
.. automodapi:: documenteer.ext.openapi
|
|
10
6
|
|
|
11
7
|
.. automodapi:: documenteer.ext.bibtex
|
|
@@ -20,6 +16,3 @@ documenteer.ext
|
|
|
20
16
|
|
|
21
17
|
.. automodapi:: documenteer.ext.mockcoderefs
|
|
22
18
|
:no-inheritance-diagram:
|
|
23
|
-
|
|
24
|
-
.. automodapi:: documenteer.ext.packagetoctree
|
|
25
|
-
:no-inheritance-diagram:
|
|
@@ -11,6 +11,7 @@ package = "documenteer"
|
|
|
11
11
|
extensions = [
|
|
12
12
|
"sphinx_click.ext",
|
|
13
13
|
"sphinxcontrib.autoprogram",
|
|
14
|
+
"sphinxcontrib.autodoc_pydantic"
|
|
14
15
|
]
|
|
15
16
|
disable_primary_sidebars = ["index", "changelog"]
|
|
16
17
|
rst_epilog_file = "_rst_epilog.rst"
|
|
@@ -25,7 +26,8 @@ nitpick_ignore_regex = [
|
|
|
25
26
|
]
|
|
26
27
|
python_api_dir = "dev/api/contents"
|
|
27
28
|
exclude = [
|
|
28
|
-
"technotes/_templates/*"
|
|
29
|
+
"technotes/_templates/*",
|
|
30
|
+
"_templates/**"
|
|
29
31
|
]
|
|
30
32
|
|
|
31
33
|
[sphinx.theme]
|
|
@@ -46,10 +48,10 @@ ignore = [
|
|
|
46
48
|
]
|
|
47
49
|
|
|
48
50
|
[sphinx.redirects]
|
|
49
|
-
"pipelines/build-overview.rst" = "guides/
|
|
50
|
-
"pipelines/configuration.rst" = "guides/
|
|
51
|
-
"pipelines/cpp-api-linking.rst" = "guides/
|
|
52
|
-
"pipelines/index.rst" = "guides/
|
|
53
|
-
"pipelines/install.rst" = "guides/
|
|
54
|
-
"pipelines/package-docs-cli.rst" = "guides/
|
|
55
|
-
"pipelines/stack-docs-cli.rst" = "guides/
|
|
51
|
+
"pipelines/build-overview.rst" = "guides/index.rst"
|
|
52
|
+
"pipelines/configuration.rst" = "guides/index.rst"
|
|
53
|
+
"pipelines/cpp-api-linking.rst" = "guides/index.rst"
|
|
54
|
+
"pipelines/index.rst" = "guides/index.rst"
|
|
55
|
+
"pipelines/install.rst" = "guides/index.rst"
|
|
56
|
+
"pipelines/package-docs-cli.rst" = "guides/index.rst"
|
|
57
|
+
"pipelines/stack-docs-cli.rst" = "guides/index.rst"
|
|
@@ -47,14 +47,6 @@ Documenteer provides a configuration profile for creating branded user guides wi
|
|
|
47
47
|
markdown-primer
|
|
48
48
|
including-notebooks
|
|
49
49
|
|
|
50
|
-
.. toctree::
|
|
51
|
-
:maxdepth: 2
|
|
52
|
-
:caption: Science Pipelines
|
|
53
|
-
:name: toc-guides-pipelines
|
|
54
|
-
:titlesonly:
|
|
55
|
-
|
|
56
|
-
pipelines/index
|
|
57
|
-
|
|
58
50
|
.. toctree::
|
|
59
51
|
:maxdepth: 2
|
|
60
52
|
:caption: Reference
|
|
@@ -23,7 +23,7 @@ These paths are relative to the documentation project's root directory (where :f
|
|
|
23
23
|
The table accepts an arbitrary number of redirects:
|
|
24
24
|
|
|
25
25
|
.. code-block:: toml
|
|
26
|
-
:
|
|
26
|
+
:caption: documenteer.toml
|
|
27
27
|
|
|
28
28
|
[sphinx.redirects]
|
|
29
29
|
"old-page.rst" = "some-dir/new-page.rst"
|
|
@@ -42,14 +42,6 @@ Installation
|
|
|
42
42
|
|
|
43
43
|
pip install "documenteer[technote]"
|
|
44
44
|
|
|
45
|
-
For :doc:`LSST Science Pipelines projects and other EUPS stacks </guides/pipelines/index>`:
|
|
46
|
-
|
|
47
|
-
.. code-block:: sh
|
|
48
|
-
|
|
49
|
-
pip install "documenteer[pipelines]"
|
|
50
|
-
|
|
51
|
-
See :doc:`/guides/pipelines/install` for more information.
|
|
52
|
-
|
|
53
45
|
.. tab-item:: conda
|
|
54
46
|
|
|
55
47
|
Documenteer is available from `conda-forge`_ for Conda_ users.
|
|
@@ -74,17 +66,11 @@ Installation
|
|
|
74
66
|
|
|
75
67
|
conda-install lsst-documenteer-technote
|
|
76
68
|
|
|
77
|
-
To install Documenteer for LSST Stack projects (such as https://pipelines.lsst.io and EUPS packages):
|
|
78
|
-
|
|
79
|
-
.. code-block:: sh
|
|
80
|
-
|
|
81
|
-
conda-install lsst-documenteer-pipelines
|
|
82
|
-
|
|
83
69
|
Project guides
|
|
84
70
|
==============
|
|
85
71
|
|
|
86
72
|
Documenteer provides centralized Sphinx configuration and support for Rubin Observatory documentation projects.
|
|
87
|
-
This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides
|
|
73
|
+
This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides.
|
|
88
74
|
|
|
89
75
|
.. toctree::
|
|
90
76
|
:maxdepth: 2
|
|
@@ -134,7 +134,7 @@ You might also want to run the linter to check links and find common issues:
|
|
|
134
134
|
make lint
|
|
135
135
|
|
|
136
136
|
If you have any questions or issues about the build, you should still proceed with committing and creating a pull request (see next step).
|
|
137
|
-
This way you can link to the repository when you reach out for help in `#
|
|
137
|
+
This way you can link to the repository when you reach out for help in `#dm-docs-support`_ on Slack.
|
|
138
138
|
|
|
139
139
|
Step 7. Commit the migration, pull request, and merge
|
|
140
140
|
=====================================================
|
|
@@ -145,7 +145,7 @@ GitHub Actions will build the technote and publish a preview version that is lin
|
|
|
145
145
|
|
|
146
146
|
If the build works, you can merge the pull request.
|
|
147
147
|
|
|
148
|
-
If there are build errors, you can reach out to `#
|
|
148
|
+
If there are build errors, you can reach out to `#dm-docs-support`_ on Slack for help.
|
|
149
149
|
Include the repository URL and ideally a link to the pull request or GitHub Actions workflow run that failed.
|
|
150
150
|
|
|
151
151
|
.. _technote-migration-detailed:
|
|
@@ -214,7 +214,7 @@ For most technotes, the :file:`conf.py` file should be a single line:
|
|
|
214
214
|
from documenteer.conf.technote import * # noqa: F401, F403
|
|
215
215
|
|
|
216
216
|
If your :file:`conf.py` file has additional content, some of that configuration may be migrated to :file:`technote.toml`.
|
|
217
|
-
Reach out to `#
|
|
217
|
+
Reach out to `#dm-docs-support`_ on Slack for advice.
|
|
218
218
|
|
|
219
219
|
index.rst file (updated)
|
|
220
220
|
------------------------
|
|
@@ -416,7 +416,7 @@ The Python dependencies for your technote are listed in a :file:`requirements.tx
|
|
|
416
416
|
|
|
417
417
|
.. note::
|
|
418
418
|
|
|
419
|
-
If your technote has additional dependencies listed, you can reach out to `#
|
|
419
|
+
If your technote has additional dependencies listed, you can reach out to `#dm-docs-support`_ on Slack if you are unsure whether they are part of the Sphinx build process or separate packages needed for any custom document preprocessing.
|
|
420
420
|
|
|
421
421
|
tox.ini file (added)
|
|
422
422
|
--------------------
|
|
@@ -15,7 +15,6 @@
|
|
|
15
15
|
"mini-css-extract-plugin": "^2.4.4",
|
|
16
16
|
"normalize.css": "^8.0.1",
|
|
17
17
|
"postcss-loader": "^6.2.0",
|
|
18
|
-
"prettier": "3.5.1",
|
|
19
18
|
"sass": "^1.53.0",
|
|
20
19
|
"sass-loader": "^12.3.0",
|
|
21
20
|
"style-loader": "^3.3.1",
|
|
@@ -2471,21 +2470,6 @@
|
|
|
2471
2470
|
"integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
|
|
2472
2471
|
"dev": true
|
|
2473
2472
|
},
|
|
2474
|
-
"node_modules/prettier": {
|
|
2475
|
-
"version": "3.5.1",
|
|
2476
|
-
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.1.tgz",
|
|
2477
|
-
"integrity": "sha512-hPpFQvHwL3Qv5AdRvBFMhnKo4tYxp0ReXiPn2bxkiohEX6mBeBwEpBSQTkD458RaaDKQMYSp4hX4UtfUTA5wDw==",
|
|
2478
|
-
"dev": true,
|
|
2479
|
-
"bin": {
|
|
2480
|
-
"prettier": "bin/prettier.cjs"
|
|
2481
|
-
},
|
|
2482
|
-
"engines": {
|
|
2483
|
-
"node": ">=14"
|
|
2484
|
-
},
|
|
2485
|
-
"funding": {
|
|
2486
|
-
"url": "https://github.com/prettier/prettier?sponsor=1"
|
|
2487
|
-
}
|
|
2488
|
-
},
|
|
2489
2473
|
"node_modules/punycode": {
|
|
2490
2474
|
"version": "2.1.1",
|
|
2491
2475
|
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
|
|
@@ -5046,12 +5030,6 @@
|
|
|
5046
5030
|
"integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
|
|
5047
5031
|
"dev": true
|
|
5048
5032
|
},
|
|
5049
|
-
"prettier": {
|
|
5050
|
-
"version": "3.5.1",
|
|
5051
|
-
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.1.tgz",
|
|
5052
|
-
"integrity": "sha512-hPpFQvHwL3Qv5AdRvBFMhnKo4tYxp0ReXiPn2bxkiohEX6mBeBwEpBSQTkD458RaaDKQMYSp4hX4UtfUTA5wDw==",
|
|
5053
|
-
"dev": true
|
|
5054
|
-
},
|
|
5055
5033
|
"punycode": {
|
|
5056
5034
|
"version": "2.1.1",
|
|
5057
5035
|
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
|