documenteer 2.0.0a2__tar.gz → 2.0.0a3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/SUPPORT.md +1 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/workflows/ci-cron.yaml +75 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/workflows/ci.yaml +23 -3
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.pre-commit-config.yaml +0 -6
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.prettierignore +2 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/PKG-INFO +5 -4
- documenteer-2.0.0a3/changelog.d/20241010_133336_danfuchs_mermaid_compat.md +4 -0
- documenteer-2.0.0a3/changelog.d/20250203_175511_jsick_DM_48755.md +3 -0
- documenteer-2.0.0a3/changelog.d/20250219_160628_jsick_DM_49037.md +19 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/_rst_epilog.rst +2 -2
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/edit-on-github.rst +1 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/migrate.rst +4 -4
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/start-a-technote.rst +1 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/package-lock.json +22 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/package.json +1 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/pyproject.toml +3 -2
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/_properties.scss +3 -3
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-pydata-theme.css +2 -2
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-technote.css +3 -3
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-technote.css.map +1 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/conf/guide.py +0 -5
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/remotecodeblock.py +1 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/PKG-INFO +5 -4
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/SOURCES.txt +3 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/requires.txt +2 -2
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tox.ini +5 -1
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.flake8 +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/CODE_OF_CONDUCT.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/CONTRIBUTING.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.github/dependabot.yml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.npmrc +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.nvmrc +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.prettierrc.yaml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.vscode/settings.json +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/.vscode/tasks.json +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/CHANGELOG.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/LICENSE +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/MANIFEST.in +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/changelog.d/20240819_152413_jsick_DM_45803.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/changelog.d/_template.md.jinja +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/diagram.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/index.ipynb +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/ipynb-technote/technote.toml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/diagram.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/index.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/md-technote/technote.toml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/diagram.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/demo/rst-technote/technote.toml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/changelog.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/api/documenteer.conf.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/api/documenteer.ext.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/api/documenteer.requestsutils.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/api/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/development.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/html-templates.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/release.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/theme-assets.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/dev/theme.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/documenteer.toml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/badges.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/configuration-preset.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/configuration.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/diagrams.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/extend-conf-py.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/including-notebooks.ipynb +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/markdown-primer.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/openapi.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/organization.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/overview.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/page-redirects.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/pyproject-configuration.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/rst-epilog.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/tabsets.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/toml-reference.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/guides/video-embeds.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/docushare-reference.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/githubbibcache.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/jira-reference.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/openapi.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/sphinx-extensions/remote-code-block.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/_templates/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/_templates/README.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/author-metadata.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/configuration.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/document-status.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/edit-locally.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/extensions.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/how-your-technote-gets-published.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/docs/technotes/wide-content.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/licenses/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/licenses/astropy-helpers.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/licenses/sphinx-issue.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/licenses/sphinx.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/postcss.config.js +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/ruff-shared.toml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/setup.cfg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/_hacks.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/.gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/favicon.ico +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-favicon.svg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/cli.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/conf/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/conf/_toml.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/conf/_utils.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/conf/technote.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/bibtex.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/githubbibcache.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/jira.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/lsstdocushare.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/mockcoderefs.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/ext/openapi.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/packagemetadata.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/py.typed +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/requestsutils.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/services/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/services/technoteauthor.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/services/technotemigration.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/authordb.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/latex.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/localtemplates.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/storage/technotetoml.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/pydata/autosummary_core/exception.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/pydata/autosummary_core/pydantic_model.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/pydata/layout.html +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/.gitkeep +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/components/.gitkeep +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/header-article.html +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/utils.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer/version.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/dependency_links.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/entry_points.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/documenteer.egg-info/top_level.txt +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/conftest.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/afw.doxygen.conf +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/authordb.yaml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/doxygen.tag.zip +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/manifest.yaml +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/include/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_alpha/src/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/data/package_beta/doc/README.md +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/ext/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/ext/jira_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/ext/lsstdocushare_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/ext/mockcoderefs_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/packagemetadata_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/conf.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/roots/test-autocppapi/index.rst +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/services/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/services/technotemigration_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/storage/__init__.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/storage/authordb_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/storage/technotetoml_test.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/test_conf_toml.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/tests/test_conf_utils.py +0 -0
- {documenteer-2.0.0a2 → documenteer-2.0.0a3}/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 #square-docs-support (for Rubin staff)](https://rubin-obs.slack.com/archives/C07QK9N14BY)
|
|
5
5
|
- [Post a GitHub issue](https://github.com/lsst-sqre/documenteer/issues/new)
|
|
@@ -12,6 +12,49 @@ env:
|
|
|
12
12
|
- cron: "0 12 * * 1"
|
|
13
13
|
|
|
14
14
|
jobs:
|
|
15
|
+
lint:
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v4
|
|
19
|
+
|
|
20
|
+
- name: Set up Python
|
|
21
|
+
uses: actions/setup-python@v5
|
|
22
|
+
with:
|
|
23
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
24
|
+
|
|
25
|
+
- uses: actions/setup-node@v4
|
|
26
|
+
with:
|
|
27
|
+
cache: 'npm'
|
|
28
|
+
node-version-file: '.nvmrc'
|
|
29
|
+
|
|
30
|
+
- name: Authenticate GitHub Packages
|
|
31
|
+
run: |
|
|
32
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
33
|
+
env:
|
|
34
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
35
|
+
|
|
36
|
+
- name: npm install and build
|
|
37
|
+
run: |
|
|
38
|
+
npm install
|
|
39
|
+
npm run build
|
|
40
|
+
|
|
41
|
+
- name: Run tox
|
|
42
|
+
uses: lsst-sqre/run-tox@v1
|
|
43
|
+
with:
|
|
44
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
45
|
+
tox-envs: 'lint'
|
|
46
|
+
use-cache: false
|
|
47
|
+
|
|
48
|
+
- name: Report status
|
|
49
|
+
if: failure()
|
|
50
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
51
|
+
with:
|
|
52
|
+
status: ${{ job.status }}
|
|
53
|
+
notify_when: "failure"
|
|
54
|
+
notification_title: "Periodic lint for {repo} failed"
|
|
55
|
+
env:
|
|
56
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
57
|
+
|
|
15
58
|
test:
|
|
16
59
|
runs-on: ubuntu-latest
|
|
17
60
|
|
|
@@ -20,6 +63,7 @@ jobs:
|
|
|
20
63
|
python-version:
|
|
21
64
|
- "3.11"
|
|
22
65
|
- "3.12"
|
|
66
|
+
- "3.13"
|
|
23
67
|
sphinx-version:
|
|
24
68
|
- "7"
|
|
25
69
|
- "8"
|
|
@@ -54,9 +98,19 @@ jobs:
|
|
|
54
98
|
uses: lsst-sqre/run-tox@v1
|
|
55
99
|
with:
|
|
56
100
|
python-version: ${{ matrix.python-version }}
|
|
57
|
-
tox-envs: "
|
|
101
|
+
tox-envs: "typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
|
|
58
102
|
use-cache: false
|
|
59
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
|
+
|
|
60
114
|
docs:
|
|
61
115
|
runs-on: ubuntu-latest
|
|
62
116
|
|
|
@@ -72,6 +126,16 @@ jobs:
|
|
|
72
126
|
tox-envs: "docs,docs-lint"
|
|
73
127
|
use-cache: false
|
|
74
128
|
|
|
129
|
+
- name: Report status
|
|
130
|
+
if: failure()
|
|
131
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
132
|
+
with:
|
|
133
|
+
status: ${{ job.status }}
|
|
134
|
+
notify_when: "failure"
|
|
135
|
+
notification_title: "Periodic documentation test for {repo} failed"
|
|
136
|
+
env:
|
|
137
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
138
|
+
|
|
75
139
|
pypi:
|
|
76
140
|
runs-on: ubuntu-latest
|
|
77
141
|
|
|
@@ -100,3 +164,13 @@ jobs:
|
|
|
100
164
|
with:
|
|
101
165
|
python-version: ${{ env.PYTHON_VERSION }}
|
|
102
166
|
upload: false
|
|
167
|
+
|
|
168
|
+
- name: Report status
|
|
169
|
+
if: failure()
|
|
170
|
+
uses: ravsamhq/notify-slack-action@v2
|
|
171
|
+
with:
|
|
172
|
+
status: ${{ job.status }}
|
|
173
|
+
notify_when: "failure"
|
|
174
|
+
notification_title: "Periodic packaging test for {repo} failed"
|
|
175
|
+
env:
|
|
176
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_ALERT_WEBHOOK }}
|
|
@@ -27,10 +27,29 @@ jobs:
|
|
|
27
27
|
- name: Set up Python
|
|
28
28
|
uses: actions/setup-python@v5
|
|
29
29
|
with:
|
|
30
|
-
python-version:
|
|
30
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
31
|
+
|
|
32
|
+
- uses: actions/setup-node@v4
|
|
33
|
+
with:
|
|
34
|
+
cache: 'npm'
|
|
35
|
+
node-version-file: '.nvmrc'
|
|
31
36
|
|
|
32
|
-
- name:
|
|
33
|
-
|
|
37
|
+
- name: Authenticate GitHub Packages
|
|
38
|
+
run: |
|
|
39
|
+
echo "//npm.pkg.github.com/:_authToken=${NPM_PKG_TOKEN}" > ~/.npmrc
|
|
40
|
+
env:
|
|
41
|
+
NPM_PKG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
42
|
+
|
|
43
|
+
- name: npm install and build
|
|
44
|
+
run: |
|
|
45
|
+
npm install
|
|
46
|
+
npm run build
|
|
47
|
+
|
|
48
|
+
- name: Run tox
|
|
49
|
+
uses: lsst-sqre/run-tox@v1
|
|
50
|
+
with:
|
|
51
|
+
python-version: ${{ env.PYTHON_VERSION }}
|
|
52
|
+
tox-envs: 'lint'
|
|
34
53
|
|
|
35
54
|
test:
|
|
36
55
|
runs-on: ubuntu-latest
|
|
@@ -40,6 +59,7 @@ jobs:
|
|
|
40
59
|
python-version:
|
|
41
60
|
- '3.11'
|
|
42
61
|
- '3.12'
|
|
62
|
+
- '3.13'
|
|
43
63
|
sphinx-version:
|
|
44
64
|
- '7'
|
|
45
65
|
- '8'
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version: 2.0.
|
|
3
|
+
Version: 2.0.0a3
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License: The MIT License (MIT)
|
|
6
6
|
|
|
@@ -38,6 +38,7 @@ Classifier: Programming Language :: Python
|
|
|
38
38
|
Classifier: Programming Language :: Python :: 3
|
|
39
39
|
Classifier: Programming Language :: Python :: 3.11
|
|
40
40
|
Classifier: Programming Language :: Python :: 3.12
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
41
42
|
Classifier: Topic :: Documentation
|
|
42
43
|
Classifier: Topic :: Documentation :: Sphinx
|
|
43
44
|
Classifier: Typing :: Typed
|
|
@@ -45,7 +46,7 @@ Requires-Python: >=3.11
|
|
|
45
46
|
Description-Content-Type: text/markdown
|
|
46
47
|
License-File: LICENSE
|
|
47
48
|
Requires-Dist: docutils>=0.20
|
|
48
|
-
Requires-Dist: Sphinx
|
|
49
|
+
Requires-Dist: Sphinx<8.2,>=7
|
|
49
50
|
Requires-Dist: PyYAML
|
|
50
51
|
Requires-Dist: GitPython
|
|
51
52
|
Requires-Dist: requests
|
|
@@ -83,7 +84,7 @@ Requires-Dist: sphinx-jinja>=2; extra == "guide"
|
|
|
83
84
|
Requires-Dist: myst-parser; extra == "guide"
|
|
84
85
|
Requires-Dist: myst-nb; extra == "guide"
|
|
85
86
|
Requires-Dist: markdown-it-py[linkify]; extra == "guide"
|
|
86
|
-
Requires-Dist: sphinxcontrib-mermaid; extra == "guide"
|
|
87
|
+
Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
|
|
87
88
|
Requires-Dist: sphinxext-opengraph; extra == "guide"
|
|
88
89
|
Requires-Dist: sphinxcontrib-redoc; extra == "guide"
|
|
89
90
|
Requires-Dist: sphinxcontrib-jquery; extra == "guide"
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<!-- Delete the sections that don't apply -->
|
|
2
|
+
|
|
3
|
+
### Backwards-incompatible changes
|
|
4
|
+
|
|
5
|
+
-
|
|
6
|
+
|
|
7
|
+
### New features
|
|
8
|
+
|
|
9
|
+
-
|
|
10
|
+
|
|
11
|
+
### Bug fixes
|
|
12
|
+
|
|
13
|
+
- Pin Sphinx < 8.2 to avoid a bug/incompatibility with the `sphinxcontrib-bibtex` extension.
|
|
14
|
+
|
|
15
|
+
### Other changes
|
|
16
|
+
|
|
17
|
+
- Drop use of the pre-commit hook for prettier, and instead run prettier directly from the tox lint environment. This change is necessary because the prettier hook for pre-commit is no longer supported.
|
|
18
|
+
|
|
19
|
+
- Add Python 3.13 to the test matrix.
|
|
@@ -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
|
+
.. _`#square-docs-support`: https://rubin-obs.slack.com/archives/C07QK9N14BY
|
|
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/
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
.. _pipx: https://pipx.pypa.io
|
|
64
64
|
.. _`LSSTC Slack Workspace`: https://lsstc.slack.com
|
|
65
65
|
|
|
66
|
-
.. |dmw-
|
|
66
|
+
.. |dmw-squarebot| replace:: `direct message with @squarebot <https://slack.com/app_redirect?app=A07PWG9UG9M&team=T02SVMGU4>`__
|
|
67
67
|
|
|
68
68
|
.. Internal links
|
|
69
69
|
|
|
@@ -25,7 +25,7 @@ For more details on this feature, see GitHub's `documentation on Editing files <
|
|
|
25
25
|
Using github.dev
|
|
26
26
|
----------------
|
|
27
27
|
|
|
28
|
-
An alternative approach is to use the
|
|
28
|
+
An alternative approach is to use the `github.dev <https://github.dev>`__ service.
|
|
29
29
|
Open the technote's GitHub page in your browser and press the :kbd:`.` key.
|
|
30
30
|
This opens a basic VS Code editor in your browser.
|
|
31
31
|
You can edit multiple files and commit your changes directly from the browser.
|
|
@@ -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 `#square-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 `#square-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 `#square-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 `#square-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,7 @@ If you don't have push access in a whole organization, you can alternatively ask
|
|
|
15
15
|
Create a technote repository through Slack
|
|
16
16
|
==========================================
|
|
17
17
|
|
|
18
|
-
1. In Slack, open a |dmw-
|
|
18
|
+
1. In Slack, open a |dmw-squarebot| and type:
|
|
19
19
|
|
|
20
20
|
.. code-block:: text
|
|
21
21
|
|
|
@@ -15,6 +15,7 @@
|
|
|
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",
|
|
18
19
|
"sass": "^1.53.0",
|
|
19
20
|
"sass-loader": "^12.3.0",
|
|
20
21
|
"style-loader": "^3.3.1",
|
|
@@ -2470,6 +2471,21 @@
|
|
|
2470
2471
|
"integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
|
|
2471
2472
|
"dev": true
|
|
2472
2473
|
},
|
|
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
|
+
},
|
|
2473
2489
|
"node_modules/punycode": {
|
|
2474
2490
|
"version": "2.1.1",
|
|
2475
2491
|
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
|
|
@@ -5030,6 +5046,12 @@
|
|
|
5030
5046
|
"integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==",
|
|
5031
5047
|
"dev": true
|
|
5032
5048
|
},
|
|
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
|
+
},
|
|
5033
5055
|
"punycode": {
|
|
5034
5056
|
"version": "2.1.1",
|
|
5035
5057
|
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
|
|
@@ -18,6 +18,7 @@ classifiers = [
|
|
|
18
18
|
"Programming Language :: Python :: 3",
|
|
19
19
|
"Programming Language :: Python :: 3.11",
|
|
20
20
|
"Programming Language :: Python :: 3.12",
|
|
21
|
+
"Programming Language :: Python :: 3.13",
|
|
21
22
|
"Topic :: Documentation",
|
|
22
23
|
"Topic :: Documentation :: Sphinx",
|
|
23
24
|
"Typing :: Typed",
|
|
@@ -26,7 +27,7 @@ requires-python = ">=3.11"
|
|
|
26
27
|
dynamic = ["version"]
|
|
27
28
|
dependencies = [
|
|
28
29
|
"docutils>=0.20", # solves an extra div bug with the bibliography directive
|
|
29
|
-
"Sphinx>=7", # Consistent docutils constraint
|
|
30
|
+
"Sphinx>=7,<8.2", # Consistent docutils constraint
|
|
30
31
|
"PyYAML",
|
|
31
32
|
"GitPython",
|
|
32
33
|
"requests",
|
|
@@ -74,7 +75,7 @@ guide = [
|
|
|
74
75
|
"myst-parser",
|
|
75
76
|
"myst-nb",
|
|
76
77
|
"markdown-it-py[linkify]",
|
|
77
|
-
"sphinxcontrib-mermaid",
|
|
78
|
+
"sphinxcontrib-mermaid>=1",
|
|
78
79
|
"sphinxext-opengraph",
|
|
79
80
|
"sphinxcontrib-redoc",
|
|
80
81
|
"sphinxcontrib-jquery",
|
{documenteer-2.0.0a2 → documenteer-2.0.0a3}/src/assets/rubin-technote/styles/_properties.scss
RENAMED
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
:root {
|
|
22
|
-
--tn-component-text-font-family:
|
|
23
|
-
|
|
24
|
-
Droid Sans, Helvetica Neue, sans-serif;
|
|
22
|
+
--tn-component-text-font-family:
|
|
23
|
+
'Source Sans 3 VF', -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
|
|
24
|
+
Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
|
|
25
25
|
--tn-component-text-color: var(--rsd-component-text-color);
|
|
26
26
|
--tn-component-toc-header-color: var(--rsd-color-primary-600);
|
|
27
27
|
--tn-component-sidebar-header-color: var(--rsd-color-primary-600);
|
|
@@ -67,8 +67,8 @@ html[data-theme='dark'] {
|
|
|
67
67
|
|
|
68
68
|
:root {
|
|
69
69
|
--pst-font-family-base: 'Source Sans Pro', var(--pst-font-family-base-system);
|
|
70
|
-
--pst-font-family-heading:
|
|
71
|
-
var(--pst-font-family-base-system);
|
|
70
|
+
--pst-font-family-heading:
|
|
71
|
+
'Source Sans Pro', var(--pst-font-family-base-system);
|
|
72
72
|
|
|
73
73
|
/* Base font size; increased for pydata-sphinx-theme default. */
|
|
74
74
|
font-size: 18px;
|
|
@@ -90,9 +90,9 @@
|
|
|
90
90
|
src: url(731c8feefe13e72a8691.woff2) format("woff2");
|
|
91
91
|
}
|
|
92
92
|
:root {
|
|
93
|
-
--tn-component-text-font-family:
|
|
94
|
-
|
|
95
|
-
Droid Sans, Helvetica Neue, sans-serif;
|
|
93
|
+
--tn-component-text-font-family:
|
|
94
|
+
"Source Sans 3 VF", -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
|
|
95
|
+
Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
|
|
96
96
|
--tn-component-text-color: var(--rsd-component-text-color);
|
|
97
97
|
--tn-component-toc-header-color: var(--rsd-color-primary-600);
|
|
98
98
|
--tn-component-sidebar-header-color: var(--rsd-color-primary-600);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;0CAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;;;;EAAA;AAKA;EACE;EAEA;APuMF;;AOrMA;EACE;APwMF;;AAzNA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n --rsd-color-blue-500: #1c81a4;\n --rsd-color-gray-100: #dce0e3;\n --rsd-color-gray-500: #6a6e6e;\n --rsd-color-gray-800: #1f2121;\n --rsd-color-gray-900: #000000; /* Pure black. */\n --rsd-color-gray-000: #ffffff; /* Pure white. */\n --rsd-color-green-500: #3cae3f;\n --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n --rsd-color-orange-500: #ed4c4c;\n --rsd-color-primary-100: #f5f5f5;\n --rsd-color-primary-200: #d9f7f6;\n --rsd-color-primary-300: #b1f2ef;\n --rsd-color-primary-400: #00babc;\n --rsd-color-primary-500: #009fa1;\n --rsd-color-primary-600: #058b8c;\n --rsd-color-primary-700: #0c4a47;\n --rsd-color-primary-800: #313333;\n --rsd-color-purple-500: #583671;\n --rsd-color-red-500: #ed4c4c;\n --rsd-color-yellow-500: #ffe266;\n --rsd-component-footer-background-color: #f5f5f5;\n --rsd-component-header-background-color: #1f2121; /* Header background color. */\n --rsd-component-header-nav-text-color: #ffffff;\n --rsd-component-header-nav-text-hover-color: #00babc;\n --rsd-component-header-nav-menulist-text-color: #1f2121;\n --rsd-component-header-nav-menulist-background-color: #ffffff;\n --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n --rsd-component-page-background-color: #ffffff; /* Page background color */\n --rsd-component-service-card-background-color: #ffffff;\n --rsd-component-service-card-text-color: #1f2121;\n --rsd-component-text-color: #1f2121; /* Body text color */\n --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n --rsd-component-text-link-color: #146685;\n --rsd-component-text-link-hover-color: #1c81a4;\n --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: normal;\n font-stretch: normal;\n src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: italic;\n font-stretch: normal;\n src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n --tn-component-text-font-family: 'Source Sans 3 VF', -apple-system,\n BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,\n Droid Sans, Helvetica Neue, sans-serif;\n --tn-component-text-color: var(--rsd-component-text-color);\n --tn-component-toc-header-color: var(--rsd-color-primary-600);\n --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n :root {\n --tn-component-h1-weight: 600;\n --tn-component-h2-weight: 500;\n --tn-component-h3-weight: 600;\n --tn-component-h4-weight: 700;\n --tn-component-h5-weight: 800;\n --tn-component-h6-weight: 800;\n }\n}\n\n@media (max-width: 76rem) {\n :root {\n --tn-component-h1-size: 2.4rem;\n --tn-component-h2-size: 1.8rem;\n --tn-component-h3-size: 1.2rem;\n --tn-component-h4-size: 1rem;\n --tn-component-h5-size: 1rem;\n --tn-component-h6-size: 1rem;\n }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n font-size: 1.1em;\n font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n list-style: none;\n margin-left: 0;\n padding-left: 0;\n margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n content: '';\n}\n\n.technote-article-header-id {\n margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n display: flex;\n flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n .rubin-technote-version-info a {\n font-weight: 500;\n }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n .technote-sidebar-section__heading {\n font-weight: 600;\n text-transform: uppercase;\n letter-spacing: 0.01em; // goes well with upper case\n }\n}\n",".mobile-rubin-technote-logo {\n display: block;\n margin: 0 auto 2rem auto;\n width: 100%;\n max-width: 12rem;\n}\n\n@media (max-width: 76em) {\n // When the primary sidebar is hidden, remove extra top margin from the\n // container so the logo is closer to the top.\n .sb-container {\n margin-top: 0;\n }\n}\n\n@media (min-width: 76em) {\n // Hide the mobile logo when the primary sidebar is visible.\n .mobile-rubin-technote-logo {\n display: none;\n margin: 0;\n }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n/*\n * Border specifically for prompt-type code blocks, which act differently\n * than code blocks. The prompt extension is used specially by Documenteer\n * technotes.\n */\n.highlight-default .highlight {\n border: var(--tn-sphinx-code-block-border-thickness) solid\n var(--tn-sphinx-code-block-border-color);\n border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n margin: 1em;\n}\n"],"names":[],"sourceRoot":""}
|
|
1
|
+
{"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;gFAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;;;;EAAA;AAKA;EACE;EAEA;APuMF;;AOrMA;EACE;APwMF;;AAzNA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n --rsd-color-blue-500: #1c81a4;\n --rsd-color-gray-100: #dce0e3;\n --rsd-color-gray-500: #6a6e6e;\n --rsd-color-gray-800: #1f2121;\n --rsd-color-gray-900: #000000; /* Pure black. */\n --rsd-color-gray-000: #ffffff; /* Pure white. */\n --rsd-color-green-500: #3cae3f;\n --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n --rsd-color-orange-500: #ed4c4c;\n --rsd-color-primary-100: #f5f5f5;\n --rsd-color-primary-200: #d9f7f6;\n --rsd-color-primary-300: #b1f2ef;\n --rsd-color-primary-400: #00babc;\n --rsd-color-primary-500: #009fa1;\n --rsd-color-primary-600: #058b8c;\n --rsd-color-primary-700: #0c4a47;\n --rsd-color-primary-800: #313333;\n --rsd-color-purple-500: #583671;\n --rsd-color-red-500: #ed4c4c;\n --rsd-color-yellow-500: #ffe266;\n --rsd-component-footer-background-color: #f5f5f5;\n --rsd-component-header-background-color: #1f2121; /* Header background color. */\n --rsd-component-header-nav-text-color: #ffffff;\n --rsd-component-header-nav-text-hover-color: #00babc;\n --rsd-component-header-nav-menulist-text-color: #1f2121;\n --rsd-component-header-nav-menulist-background-color: #ffffff;\n --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n --rsd-component-page-background-color: #ffffff; /* Page background color */\n --rsd-component-service-card-background-color: #ffffff;\n --rsd-component-service-card-text-color: #1f2121;\n --rsd-component-text-color: #1f2121; /* Body text color */\n --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n --rsd-component-text-link-color: #146685;\n --rsd-component-text-link-hover-color: #1c81a4;\n --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: normal;\n font-stretch: normal;\n src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n font-family: 'Source Sans 3 VF';\n font-weight: 200 900;\n font-style: italic;\n font-stretch: normal;\n src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n --tn-component-text-font-family:\n 'Source Sans 3 VF', -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,\n Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;\n --tn-component-text-color: var(--rsd-component-text-color);\n --tn-component-toc-header-color: var(--rsd-color-primary-600);\n --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n :root {\n --tn-component-h1-weight: 600;\n --tn-component-h2-weight: 500;\n --tn-component-h3-weight: 600;\n --tn-component-h4-weight: 700;\n --tn-component-h5-weight: 800;\n --tn-component-h6-weight: 800;\n }\n}\n\n@media (max-width: 76rem) {\n :root {\n --tn-component-h1-size: 2.4rem;\n --tn-component-h2-size: 1.8rem;\n --tn-component-h3-size: 1.2rem;\n --tn-component-h4-size: 1rem;\n --tn-component-h5-size: 1rem;\n --tn-component-h6-size: 1rem;\n }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n font-size: 1.1em;\n font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n list-style: none;\n margin-left: 0;\n padding-left: 0;\n margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n content: '';\n}\n\n.technote-article-header-id {\n margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n display: flex;\n flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n .rubin-technote-version-info a {\n font-weight: 500;\n }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n .technote-sidebar-section__heading {\n font-weight: 600;\n text-transform: uppercase;\n letter-spacing: 0.01em; // goes well with upper case\n }\n}\n",".mobile-rubin-technote-logo {\n display: block;\n margin: 0 auto 2rem auto;\n width: 100%;\n max-width: 12rem;\n}\n\n@media (max-width: 76em) {\n // When the primary sidebar is hidden, remove extra top margin from the\n // container so the logo is closer to the top.\n .sb-container {\n margin-top: 0;\n }\n}\n\n@media (min-width: 76em) {\n // Hide the mobile logo when the primary sidebar is visible.\n .mobile-rubin-technote-logo {\n display: none;\n margin: 0;\n }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n/*\n * Border specifically for prompt-type code blocks, which act differently\n * than code blocks. The prompt extension is used specially by Documenteer\n * technotes.\n */\n.highlight-default .highlight {\n border: var(--tn-sphinx-code-block-border-thickness) solid\n var(--tn-sphinx-code-block-border-color);\n border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n margin: 1em;\n}\n"],"names":[],"sourceRoot":""}
|
|
@@ -103,7 +103,6 @@ __all__ = [
|
|
|
103
103
|
"myst_enable_extensions",
|
|
104
104
|
# MERMAID
|
|
105
105
|
"mermaid_output_format",
|
|
106
|
-
"mermaid_version",
|
|
107
106
|
# OPENGRAPH
|
|
108
107
|
"ogp_site_url",
|
|
109
108
|
"ogp_site_name",
|
|
@@ -439,10 +438,6 @@ myst_enable_extensions = [
|
|
|
439
438
|
# Mermaid CLI installation
|
|
440
439
|
mermaid_output_format = "raw"
|
|
441
440
|
|
|
442
|
-
# Temporary workaround for not getting mermaid 10 successfully from unpkg
|
|
443
|
-
# https://github.com/mgaitan/sphinxcontrib-mermaid/issues/110
|
|
444
|
-
mermaid_version = "9.4.0"
|
|
445
|
-
|
|
446
441
|
# ============================================================================
|
|
447
442
|
# #OPENGRAPH OpenGraph diagram support
|
|
448
443
|
# https://github.com/wpilibsuite/sphinxext-opengraph
|
|
@@ -12,7 +12,7 @@ from docutils import nodes
|
|
|
12
12
|
from docutils.parsers.rst import directives
|
|
13
13
|
from sphinx.application import Sphinx
|
|
14
14
|
from sphinx.directives.code import LiteralIncludeReader, container_wrapper
|
|
15
|
-
from sphinx.util import logging, parselinenos
|
|
15
|
+
from sphinx.util import logging, parselinenos # type: ignore[attr-defined]
|
|
16
16
|
from sphinx.util.docutils import SphinxDirective
|
|
17
17
|
from sphinx.util.nodes import set_source_info
|
|
18
18
|
from sphinx.util.typing import ExtensionMetadata
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version: 2.0.
|
|
3
|
+
Version: 2.0.0a3
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License: The MIT License (MIT)
|
|
6
6
|
|
|
@@ -38,6 +38,7 @@ Classifier: Programming Language :: Python
|
|
|
38
38
|
Classifier: Programming Language :: Python :: 3
|
|
39
39
|
Classifier: Programming Language :: Python :: 3.11
|
|
40
40
|
Classifier: Programming Language :: Python :: 3.12
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
41
42
|
Classifier: Topic :: Documentation
|
|
42
43
|
Classifier: Topic :: Documentation :: Sphinx
|
|
43
44
|
Classifier: Typing :: Typed
|
|
@@ -45,7 +46,7 @@ Requires-Python: >=3.11
|
|
|
45
46
|
Description-Content-Type: text/markdown
|
|
46
47
|
License-File: LICENSE
|
|
47
48
|
Requires-Dist: docutils>=0.20
|
|
48
|
-
Requires-Dist: Sphinx
|
|
49
|
+
Requires-Dist: Sphinx<8.2,>=7
|
|
49
50
|
Requires-Dist: PyYAML
|
|
50
51
|
Requires-Dist: GitPython
|
|
51
52
|
Requires-Dist: requests
|
|
@@ -83,7 +84,7 @@ Requires-Dist: sphinx-jinja>=2; extra == "guide"
|
|
|
83
84
|
Requires-Dist: myst-parser; extra == "guide"
|
|
84
85
|
Requires-Dist: myst-nb; extra == "guide"
|
|
85
86
|
Requires-Dist: markdown-it-py[linkify]; extra == "guide"
|
|
86
|
-
Requires-Dist: sphinxcontrib-mermaid; extra == "guide"
|
|
87
|
+
Requires-Dist: sphinxcontrib-mermaid>=1; extra == "guide"
|
|
87
88
|
Requires-Dist: sphinxext-opengraph; extra == "guide"
|
|
88
89
|
Requires-Dist: sphinxcontrib-redoc; extra == "guide"
|
|
89
90
|
Requires-Dist: sphinxcontrib-jquery; extra == "guide"
|
|
@@ -26,6 +26,9 @@ webpack.config.js
|
|
|
26
26
|
.vscode/settings.json
|
|
27
27
|
.vscode/tasks.json
|
|
28
28
|
changelog.d/20240819_152413_jsick_DM_45803.md
|
|
29
|
+
changelog.d/20241010_133336_danfuchs_mermaid_compat.md
|
|
30
|
+
changelog.d/20250203_175511_jsick_DM_48755.md
|
|
31
|
+
changelog.d/20250219_160628_jsick_DM_49037.md
|
|
29
32
|
changelog.d/_template.md.jinja
|
|
30
33
|
demo/ipynb-technote/.gitignore
|
|
31
34
|
demo/ipynb-technote/Makefile
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
docutils>=0.20
|
|
2
|
-
Sphinx
|
|
2
|
+
Sphinx<8.2,>=7
|
|
3
3
|
PyYAML
|
|
4
4
|
GitPython
|
|
5
5
|
requests
|
|
@@ -39,7 +39,7 @@ sphinx-jinja>=2
|
|
|
39
39
|
myst-parser
|
|
40
40
|
myst-nb
|
|
41
41
|
markdown-it-py[linkify]
|
|
42
|
-
sphinxcontrib-mermaid
|
|
42
|
+
sphinxcontrib-mermaid>=1
|
|
43
43
|
sphinxext-opengraph
|
|
44
44
|
sphinxcontrib-redoc
|
|
45
45
|
sphinxcontrib-jquery
|
|
@@ -40,9 +40,13 @@ commands =
|
|
|
40
40
|
[testenv:lint]
|
|
41
41
|
description = Lint codebase by running pre-commit (Black, isort, Flake8).
|
|
42
42
|
skip_install = true
|
|
43
|
+
allowlist_externals =
|
|
44
|
+
npx
|
|
43
45
|
deps =
|
|
44
46
|
pre-commit
|
|
45
|
-
commands =
|
|
47
|
+
commands =
|
|
48
|
+
pre-commit run --all-files
|
|
49
|
+
npx prettier '**/*.{css,scss,js}' --write
|
|
46
50
|
|
|
47
51
|
[testenv:typing-sphinx{7,8,dev}]
|
|
48
52
|
description = Run mypy.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|