documenteer 1.3.0__tar.gz → 1.4.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {documenteer-1.3.0 → documenteer-1.4.0}/CHANGELOG.md +7 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/PKG-INFO +2 -2
- documenteer-1.4.0/demo/md-technote/index.md +203 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/changelog.md +7 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/page-redirects.rst +1 -1
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/index.rst +6 -0
- documenteer-1.4.0/docs/technotes/wide-content.rst +145 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/pyproject.toml +1 -1
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/_hacks.scss +3 -13
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-technote.css +3 -11
- documenteer-1.4.0/src/documenteer/assets/rubin-technote.css.map +1 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/PKG-INFO +2 -2
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/SOURCES.txt +1 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/requires.txt +1 -1
- documenteer-1.3.0/demo/md-technote/index.md +0 -73
- documenteer-1.3.0/src/documenteer/assets/rubin-technote.css.map +0 -1
- {documenteer-1.3.0 → documenteer-1.4.0}/.flake8 +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/CODE_OF_CONDUCT.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/CONTRIBUTING.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/SUPPORT.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/dependabot.yml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/workflows/ci-cron.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/workflows/ci.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.github/workflows/dependencies.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.npmrc +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.nvmrc +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.pre-commit-config.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.prettierignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.prettierrc.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.vscode/settings.json +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/.vscode/tasks.json +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/LICENSE +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/MANIFEST.in +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/changelog.d/_template.md.jinja +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/diagram.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/extra-notebook.ipynb +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/index.ipynb +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/subdir/subdir-notebook.ipynb +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/ipynb-technote/technote.toml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/md-technote/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/md-technote/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/md-technote/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/md-technote/diagram.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/md-technote/technote.toml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/diagram.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/demo/rst-technote/technote.toml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/_rst_epilog.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/documenteer.conf.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/documenteer.ext.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/documenteer.requestsutils.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/documenteer.sphinxrunner.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/documenteer.stackdocs.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/api/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/development.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/html-templates.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/release.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/theme-assets.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/dev/theme.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/documenteer.toml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/badges.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/configuration-preset.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/configuration.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/diagrams.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/extend-conf-py.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/including-notebooks.ipynb +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/markdown-primer.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/openapi.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/organization.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/overview.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/build-overview.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/configuration.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/cpp-api-linking.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/install.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/package-docs-cli.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pipelines/stack-docs-cli.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/pyproject-configuration.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/rst-epilog.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/tabsets.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/toml-reference.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/guides/video-embeds.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/autocppapi.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/autodocreset.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/docushare-reference.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/githubbibcache.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/jira-reference.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/lsst-pybtex-style.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/lssttasks.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/openapi.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/package-toctree.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/sphinx-extensions/remote-code-block.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/_templates/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/_templates/README.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/author-metadata.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/configuration.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/document-status.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/edit-locally.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/edit-on-github.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/extensions.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/how-your-technote-gets-published.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/migrate.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/docs/technotes/start-a-technote.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/licenses/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/licenses/astropy-helpers.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/licenses/sphinx-issue.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/licenses/sphinx.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/package-lock.json +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/package.json +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/postcss.config.js +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/setup.cfg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/SourceSans3VF-Italic.ttf.woff2 +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/SourceSans3VF-Upright.ttf.woff2 +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/_properties.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_article-header.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_authors.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_index.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_sidebar-section.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/components/_version-info.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/assets/rubin-technote/styles/rubin-technote.scss +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/.gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/731c8feefe13e72a8691.woff2 +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/b8bc3440ba2145e132f5.woff2 +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/favicon.ico +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-black-crop.svg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rsd-assets/rubin-imagotype-color-on-white-crop.svg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-favicon-transparent-32px.png +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-favicon.svg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-pydata-theme.css +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-titlebar-imagotype-dark.svg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/rubin-titlebar-imagotype-light.svg +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/scripts/rubin-technote.js +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/assets/scripts/rubin-technote.js.map +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/cli.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/_toml.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/_utils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/guide.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/pipelines.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/pipelinespkg.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/conf/technote.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/_utils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/autocppapi.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/autodocreset.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/bibtex.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/githubbibcache.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/jira.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lsstdocushare.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/configfieldlists.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/crossrefs.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/pyapisummary.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/taskutils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/topiclists.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/lssttasks/topics.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/mockcoderefs.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/openapi.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/packagetoctree.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/ext/remotecodeblock.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/packagemetadata.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/py.typed +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/requestsutils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/services/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/services/technoteauthor.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/services/technotemigration.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/sphinxrunner.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/build.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/data/cppreference-doxygen-web.tag.xml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/data/doxygen.defaults.conf +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/data/mainpage.dox +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/doxygen.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/doxygentag.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/packagecli.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/pkgdiscovery.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/rootdiscovery.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/stackdocs/stackcli.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/authordb.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/latex.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/Makefile +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/README.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/ci.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/dependabot.yml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/gitignore +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/pre-commit-config.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/requirements.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates/technote/tox.ini +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/localtemplates.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/storage/technotetoml.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/pydata/layout.html +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/.gitkeep +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/components/.gitkeep +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/components/sidebar-source.html +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/sections/.gitkeep +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/sections/header-article.html +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/templates/technote/sections/sidebar-primary.html +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/utils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer/version.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/dependency_links.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/entry_points.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/src/documenteer.egg-info/top_level.txt +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/conftest.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/afw.doxygen.conf +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/authordb.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/doxygen.tag.zip +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/doc/_static/package_alpha/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/doc/doxygen.conf.in +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/doc/manifest.yaml +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/doc/package.alpha/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/doc/package_alpha/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/include/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_alpha/src/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/data/package_beta/doc/README.md +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/autocppapi_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/jira_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/lsstdocushare_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/lssttasks/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/lssttasks/taskutils_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/mockcoderefs_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/packagetoctree_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/ext/utils_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/packagemetadata_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/roots/test-autocppapi/conf.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/roots/test-autocppapi/doxygen.tag.zip +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/roots/test-autocppapi/index.rst +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/services/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/services/technotemigration_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/storage/__init__.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/storage/authordb_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/storage/technotetoml_test.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_conf_toml.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_conf_utils.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_stackdocs_build.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_stackdocs_doxygen.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_stackdocs_doxygentag.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_stackdocs_pkgdiscovery.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tests/test_stackdocs_rootdiscovery.py +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/tox.ini +0 -0
- {documenteer-1.3.0 → documenteer-1.4.0}/webpack.config.js +0 -0
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- scriv-insert-here -->
|
|
4
4
|
|
|
5
|
+
<a id='changelog-1.4.0'></a>
|
|
6
|
+
## 1.4.0 (2024-07-11)
|
|
7
|
+
|
|
8
|
+
### New features
|
|
9
|
+
|
|
10
|
+
- Update to technote 0.9.0. This new version of the technote theme features a two column layout that allows wide content, such as tables, code blocks, and figures, to span the full width of the page (bleeding beyond the text column).
|
|
11
|
+
|
|
5
12
|
<a id='changelog-1.3.0'></a>
|
|
6
13
|
## 1.3.0 (2024-05-03)
|
|
7
14
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.4.0
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License: The MIT License (MIT)
|
|
6
6
|
|
|
@@ -104,7 +104,7 @@ Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
|
|
|
104
104
|
Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
|
|
105
105
|
Requires-Dist: sphinx-click; extra == "pipelines"
|
|
106
106
|
Provides-Extra: technote
|
|
107
|
-
Requires-Dist: technote<0.
|
|
107
|
+
Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
|
|
108
108
|
Requires-Dist: sphinx-prompt; extra == "technote"
|
|
109
109
|
Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
|
|
110
110
|
Requires-Dist: sphinx-diagrams; extra == "technote"
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# Demo technote
|
|
2
|
+
|
|
3
|
+
```{abstract}
|
|
4
|
+
A *technote* is a web-native single page document that enables rapid technical communication within and across teams.
|
|
5
|
+
```
|
|
6
|
+
|
|
7
|
+
## Introduction
|
|
8
|
+
|
|
9
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
10
|
+
|
|
11
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
12
|
+
|
|
13
|
+
A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`.
|
|
14
|
+
|
|
15
|
+
This is `inline code`.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Images and figures
|
|
19
|
+
|
|
20
|
+
A figure with a caption:
|
|
21
|
+
|
|
22
|
+
```{figure} https://placehold.co/1200x400
|
|
23
|
+
|
|
24
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Wide figures
|
|
28
|
+
|
|
29
|
+
A figure marked with the `technote-wide-content` class applied as a `figclass` option:
|
|
30
|
+
|
|
31
|
+
```{figure} https://placehold.co/1200x400
|
|
32
|
+
:figclass: technote-wide-content
|
|
33
|
+
|
|
34
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Tables
|
|
38
|
+
|
|
39
|
+
A table:
|
|
40
|
+
|
|
41
|
+
```{list-table}
|
|
42
|
+
:header-rows: 1
|
|
43
|
+
|
|
44
|
+
* - Column 1
|
|
45
|
+
- Column 2
|
|
46
|
+
- Column 3
|
|
47
|
+
* - Row 1
|
|
48
|
+
- 1
|
|
49
|
+
- 1
|
|
50
|
+
* - Row 2
|
|
51
|
+
- 2
|
|
52
|
+
- 2
|
|
53
|
+
* - Row 3
|
|
54
|
+
- 3
|
|
55
|
+
- 3
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
A table marked with the `technote-wide-content` class:
|
|
59
|
+
|
|
60
|
+
```{rst-class} technote-wide-content
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
```{list-table}
|
|
64
|
+
:header-rows: 1
|
|
65
|
+
|
|
66
|
+
* - Column 1
|
|
67
|
+
- Column 2
|
|
68
|
+
- Column 3
|
|
69
|
+
- Column 4
|
|
70
|
+
- Column 5
|
|
71
|
+
- Column 6
|
|
72
|
+
- Column 7
|
|
73
|
+
* - Row 1
|
|
74
|
+
- lorem ipsum dolor sit amet consectetur adipiscing elit
|
|
75
|
+
- lorem ipsum dolor
|
|
76
|
+
- lorem ipsum dolor
|
|
77
|
+
- 5
|
|
78
|
+
- 6
|
|
79
|
+
- Lorem ipsum
|
|
80
|
+
* - Row 2
|
|
81
|
+
- 6
|
|
82
|
+
- 7
|
|
83
|
+
- 8
|
|
84
|
+
- 9
|
|
85
|
+
- 10
|
|
86
|
+
- Lorem ipsum
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
90
|
+
|
|
91
|
+
### Code blocks
|
|
92
|
+
|
|
93
|
+
A regular code block:
|
|
94
|
+
|
|
95
|
+
```{code-block} python
|
|
96
|
+
print("Hello, world!")
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
And with a caption:
|
|
100
|
+
|
|
101
|
+
```{code-block} python
|
|
102
|
+
:caption: A code block with a caption
|
|
103
|
+
|
|
104
|
+
print("Hello, world!")
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
A wide code block without a caption:
|
|
108
|
+
|
|
109
|
+
```{rst-class} technote-wide-content
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```{code-block} python
|
|
113
|
+
print("Hello, world! This is a code block. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.")
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
A wide code block with a caption where the class is set externally:
|
|
117
|
+
|
|
118
|
+
```{rst-class} technote-wide-content
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
```{code-block} python
|
|
122
|
+
:caption: A wide code block. This is a long caption. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
123
|
+
|
|
124
|
+
print("Hello, world! This is a code block. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.")
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
A code prompt:
|
|
128
|
+
|
|
129
|
+
```{prompt} bash
|
|
130
|
+
git add index.rst
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Admonitions
|
|
134
|
+
|
|
135
|
+
An admonition:
|
|
136
|
+
|
|
137
|
+
```{note}
|
|
138
|
+
This is a note. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
139
|
+
|
|
140
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Lists
|
|
144
|
+
|
|
145
|
+
A bulleted list:
|
|
146
|
+
|
|
147
|
+
- Item 1
|
|
148
|
+
- Item 2
|
|
149
|
+
- Item 3
|
|
150
|
+
|
|
151
|
+
A numbered list:
|
|
152
|
+
|
|
153
|
+
1. Item 1
|
|
154
|
+
2. Item 2
|
|
155
|
+
3. Item 3
|
|
156
|
+
|
|
157
|
+
A bulleted list with a nested numbered list:
|
|
158
|
+
|
|
159
|
+
- Item 1
|
|
160
|
+
1. Item 1.1
|
|
161
|
+
2. Item 1.2
|
|
162
|
+
- Item 2
|
|
163
|
+
- Item 3
|
|
164
|
+
|
|
165
|
+
A definition list:
|
|
166
|
+
|
|
167
|
+
term 1
|
|
168
|
+
Definition 1
|
|
169
|
+
term 2
|
|
170
|
+
Definition 2 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nisl quis molestie ultricies, nunc nisl aliquet nunc, quis aliquam nisl nunc eu nisl.
|
|
171
|
+
|
|
172
|
+
## Links
|
|
173
|
+
|
|
174
|
+
A link to [Rubin Observatory](https://www.rubinobservatory.org).
|
|
175
|
+
|
|
176
|
+
## Analysis
|
|
177
|
+
|
|
178
|
+
A flowchart made with Mermaid:
|
|
179
|
+
|
|
180
|
+
```{mermaid}
|
|
181
|
+
graph TD
|
|
182
|
+
A[Square Rect] -- Link text --> B((Circle))
|
|
183
|
+
A --> C(Round Rect)
|
|
184
|
+
B --> D{Rhombus}
|
|
185
|
+
C --> D
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
A diagram:
|
|
189
|
+
|
|
190
|
+
```{rst-class} technote-wide-content
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
```{diagrams} diagram.py
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## Conclusion
|
|
197
|
+
|
|
198
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
199
|
+
|
|
200
|
+
## References
|
|
201
|
+
|
|
202
|
+
```{bibliography}
|
|
203
|
+
```
|
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
<!-- scriv-insert-here -->
|
|
4
4
|
|
|
5
|
+
<a id='changelog-1.4.0'></a>
|
|
6
|
+
## 1.4.0 (2024-07-11)
|
|
7
|
+
|
|
8
|
+
### New features
|
|
9
|
+
|
|
10
|
+
- Update to technote 0.9.0. This new version of the technote theme features a two column layout that allows wide content, such as tables, code blocks, and figures, to span the full width of the page (bleeding beyond the text column).
|
|
11
|
+
|
|
5
12
|
<a id='changelog-1.3.0'></a>
|
|
6
13
|
## 1.3.0 (2024-05-03)
|
|
7
14
|
|
|
@@ -18,7 +18,7 @@ To create a redirect from the old page to the new one, add the following to the
|
|
|
18
18
|
[sphinx.redirects]
|
|
19
19
|
"old-page.rst" = "some-dir/new-page.rst"
|
|
20
20
|
|
|
21
|
-
These paths are relative to the documentation project's root directory (where :file:`conf.py` and :
|
|
21
|
+
These paths are relative to the documentation project's root directory (where :file:`conf.py` and :file:`documenteer.toml` are located) and include the file extension (e.g., :file:`.rst` or :file:`.md`).
|
|
22
22
|
|
|
23
23
|
The table accepts an arbitrary number of redirects:
|
|
24
24
|
|
|
@@ -24,6 +24,12 @@ Documenteer provides centralized configuration and tooling for technotes.
|
|
|
24
24
|
author-metadata
|
|
25
25
|
document-status
|
|
26
26
|
|
|
27
|
+
.. toctree::
|
|
28
|
+
:maxdepth: 2
|
|
29
|
+
:caption: Content & design
|
|
30
|
+
|
|
31
|
+
wide-content
|
|
32
|
+
|
|
27
33
|
.. toctree::
|
|
28
34
|
:maxdepth: 2
|
|
29
35
|
:caption: Sphinx configuration
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
############################################################
|
|
2
|
+
Accommodating wide content (tables, code blocks, and images)
|
|
3
|
+
############################################################
|
|
4
|
+
|
|
5
|
+
Technotes use a narrow content column to improve readability.
|
|
6
|
+
However, some content types need to more horizontal space.
|
|
7
|
+
This page explains how to use the ``technote-wide-content`` CSS utility class to let content span the full width of the page.
|
|
8
|
+
|
|
9
|
+
Tables and code blocks
|
|
10
|
+
======================
|
|
11
|
+
|
|
12
|
+
To allow a table or code block to span the available horizontal space on a page, you can preceed it with the ``technote-wide-content`` class in a ``rst-class`` directive.
|
|
13
|
+
The ``rst-class`` directive is not part of the table or code-block's directive, but is a separate preceeding directive that applies the ``technote-wide-content`` class to the following content.
|
|
14
|
+
|
|
15
|
+
Tables
|
|
16
|
+
------
|
|
17
|
+
|
|
18
|
+
.. tab-set::
|
|
19
|
+
|
|
20
|
+
.. tab-item:: reStructuredText
|
|
21
|
+
:sync: rst
|
|
22
|
+
|
|
23
|
+
.. code-block:: rst
|
|
24
|
+
|
|
25
|
+
.. rst-class:: technote-wide-content
|
|
26
|
+
|
|
27
|
+
+-----------------+-----------------+
|
|
28
|
+
| Header 1 | Header 2 |
|
|
29
|
+
+=================+=================+
|
|
30
|
+
| Row 1, Column 1 | Row 1, Column 2 |
|
|
31
|
+
+-----------------+-----------------+
|
|
32
|
+
| Row 2, Column 1 | Row 2, Column 2 |
|
|
33
|
+
+-----------------+-----------------+
|
|
34
|
+
|
|
35
|
+
.. tab-item:: markdown
|
|
36
|
+
:sync: md
|
|
37
|
+
|
|
38
|
+
.. code-block:: md
|
|
39
|
+
|
|
40
|
+
```{rst-class} technote-wide-content
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
| Header 1 | Header 2 |
|
|
44
|
+
| --------------- | --------------- |
|
|
45
|
+
| Row 1, Column 1 | Row 1, Column 2 |
|
|
46
|
+
| Row 2, Column 1 | Row 2, Column 2 |
|
|
47
|
+
|
|
48
|
+
List tables
|
|
49
|
+
-----------
|
|
50
|
+
|
|
51
|
+
.. tab-set::
|
|
52
|
+
|
|
53
|
+
.. tab-item:: reStructuredText
|
|
54
|
+
:sync: rst
|
|
55
|
+
|
|
56
|
+
.. code-block:: rst
|
|
57
|
+
|
|
58
|
+
.. rst-class:: technote-wide-content
|
|
59
|
+
|
|
60
|
+
.. list-table::
|
|
61
|
+
:header-rows: 1
|
|
62
|
+
|
|
63
|
+
* - Header 1
|
|
64
|
+
- Header 2
|
|
65
|
+
* - Row 1, Column 1
|
|
66
|
+
- Row 1, Column 2
|
|
67
|
+
* - Row 2, Column 1
|
|
68
|
+
- Row 2, Column 2
|
|
69
|
+
|
|
70
|
+
.. tab-item:: markdown
|
|
71
|
+
|
|
72
|
+
.. code-block:: md
|
|
73
|
+
|
|
74
|
+
```{rst-class} technote-wide-content
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
```{list-table}
|
|
78
|
+
:header-rows: 1
|
|
79
|
+
|
|
80
|
+
* - Header 1
|
|
81
|
+
- Header 2
|
|
82
|
+
* - Row 1, Column 1
|
|
83
|
+
- Row 1, Column 2
|
|
84
|
+
* - Row 2, Column 1
|
|
85
|
+
- Row 2, Column 2
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Code blocks
|
|
89
|
+
-----------
|
|
90
|
+
|
|
91
|
+
.. tab-set::
|
|
92
|
+
|
|
93
|
+
.. tab-item:: reStructuredText
|
|
94
|
+
:sync: rst
|
|
95
|
+
|
|
96
|
+
.. code-block:: rst
|
|
97
|
+
|
|
98
|
+
.. rst-class:: technote-wide-content
|
|
99
|
+
|
|
100
|
+
.. code-block:: python
|
|
101
|
+
|
|
102
|
+
def my_function():
|
|
103
|
+
return "Hello, world!"
|
|
104
|
+
|
|
105
|
+
.. tab-item:: markdown
|
|
106
|
+
:sync: md
|
|
107
|
+
|
|
108
|
+
.. code-block:: md
|
|
109
|
+
|
|
110
|
+
```{rst-class} technote-wide-content
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
```python
|
|
114
|
+
def my_function():
|
|
115
|
+
return "Hello, world!"
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Images and figures
|
|
119
|
+
==================
|
|
120
|
+
|
|
121
|
+
In technotes, plots and images should be presented with the ``figure`` directive so that they can be captioned and referenced.
|
|
122
|
+
Figures support a ``figclass`` option that is compatible with the ``technote-wide-content`` class, which lets you avoid using a separate ``rst-class`` directive.
|
|
123
|
+
|
|
124
|
+
.. tab-set::
|
|
125
|
+
|
|
126
|
+
.. tab-item:: reStructuredText
|
|
127
|
+
:sync: rst
|
|
128
|
+
|
|
129
|
+
.. code-block:: rst
|
|
130
|
+
|
|
131
|
+
.. figure:: my-plot.png
|
|
132
|
+
:figclass: technote-wide-content
|
|
133
|
+
|
|
134
|
+
My plot.
|
|
135
|
+
|
|
136
|
+
.. tab-item:: markdown
|
|
137
|
+
:sync: md
|
|
138
|
+
|
|
139
|
+
.. code-block:: md
|
|
140
|
+
|
|
141
|
+
```{figure} my-plot.png
|
|
142
|
+
:figclass: technote-wide-content
|
|
143
|
+
|
|
144
|
+
My plot.
|
|
145
|
+
```
|
|
@@ -4,20 +4,10 @@
|
|
|
4
4
|
* their proper module either in documenteer or in the parent technote theme.
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
|
-
@media (max-width: 76rem) {
|
|
8
|
-
// Reduce the margin-bottom on headings in mobile views
|
|
9
|
-
h1,
|
|
10
|
-
h2,
|
|
11
|
-
h3,
|
|
12
|
-
h4,
|
|
13
|
-
h5,
|
|
14
|
-
h6 {
|
|
15
|
-
margin-bottom: 0.5em;
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
|
|
19
7
|
/*
|
|
20
|
-
* Border
|
|
8
|
+
* Border specifically for prompt-type code blocks, which act differently
|
|
9
|
+
* than code blocks. The prompt extension is used specially by Documenteer
|
|
10
|
+
* technotes.
|
|
21
11
|
*/
|
|
22
12
|
.highlight-default .highlight {
|
|
23
13
|
border: var(--tn-sphinx-code-block-border-thickness) solid
|
|
@@ -206,18 +206,10 @@
|
|
|
206
206
|
* other selectors. These selectors should eventually be refactored into
|
|
207
207
|
* their proper module either in documenteer or in the parent technote theme.
|
|
208
208
|
*/
|
|
209
|
-
@media (max-width: 76rem) {
|
|
210
|
-
h1,
|
|
211
|
-
h2,
|
|
212
|
-
h3,
|
|
213
|
-
h4,
|
|
214
|
-
h5,
|
|
215
|
-
h6 {
|
|
216
|
-
margin-bottom: 0.5em;
|
|
217
|
-
}
|
|
218
|
-
}
|
|
219
209
|
/*
|
|
220
|
-
* Border
|
|
210
|
+
* Border specifically for prompt-type code blocks, which act differently
|
|
211
|
+
* than code blocks. The prompt extension is used specially by Documenteer
|
|
212
|
+
* technotes.
|
|
221
213
|
*/
|
|
222
214
|
.highlight-default .highlight {
|
|
223
215
|
border: var(--tn-sphinx-code-block-border-thickness) solid var(--tn-sphinx-code-block-border-color);
|
|
@@ -0,0 +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,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: documenteer
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.4.0
|
|
4
4
|
Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
|
|
5
5
|
License: The MIT License (MIT)
|
|
6
6
|
|
|
@@ -104,7 +104,7 @@ Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
|
|
|
104
104
|
Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
|
|
105
105
|
Requires-Dist: sphinx-click; extra == "pipelines"
|
|
106
106
|
Provides-Extra: technote
|
|
107
|
-
Requires-Dist: technote<0.
|
|
107
|
+
Requires-Dist: technote<0.10.0,>=0.9.0; extra == "technote"
|
|
108
108
|
Requires-Dist: sphinx-prompt; extra == "technote"
|
|
109
109
|
Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
|
|
110
110
|
Requires-Dist: sphinx-diagrams; extra == "technote"
|
|
@@ -110,6 +110,7 @@ docs/technotes/how-your-technote-gets-published.rst
|
|
|
110
110
|
docs/technotes/index.rst
|
|
111
111
|
docs/technotes/migrate.rst
|
|
112
112
|
docs/technotes/start-a-technote.rst
|
|
113
|
+
docs/technotes/wide-content.rst
|
|
113
114
|
docs/technotes/_templates/README.md
|
|
114
115
|
docs/technotes/_templates/README.rst
|
|
115
116
|
licenses/README.md
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
# Demo technote
|
|
2
|
-
|
|
3
|
-
```{abstract}
|
|
4
|
-
A *technote* is a web-native single page document that enables rapid technical communication within and across teams.
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
## Introduction
|
|
8
|
-
|
|
9
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
10
|
-
|
|
11
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
12
|
-
|
|
13
|
-
A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`.
|
|
14
|
-
|
|
15
|
-
## Method
|
|
16
|
-
|
|
17
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
18
|
-
|
|
19
|
-
A list:
|
|
20
|
-
|
|
21
|
-
- First item
|
|
22
|
-
- Second item
|
|
23
|
-
- Third item
|
|
24
|
-
|
|
25
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
26
|
-
|
|
27
|
-
```{code-block} python
|
|
28
|
-
:caption: hello.py
|
|
29
|
-
|
|
30
|
-
print("Hello world")
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Results
|
|
34
|
-
|
|
35
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
36
|
-
|
|
37
|
-
### Subsection
|
|
38
|
-
|
|
39
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
40
|
-
|
|
41
|
-
#### Subsubsection
|
|
42
|
-
|
|
43
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
44
|
-
|
|
45
|
-
## Analysis
|
|
46
|
-
|
|
47
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
48
|
-
|
|
49
|
-
```{prompt} bash
|
|
50
|
-
git add index.rst
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Some following text.
|
|
54
|
-
|
|
55
|
-
```{mermaid}
|
|
56
|
-
graph TD
|
|
57
|
-
A[Square Rect] -- Link text --> B((Circle))
|
|
58
|
-
A --> C(Round Rect)
|
|
59
|
-
B --> D{Rhombus}
|
|
60
|
-
C --> D
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
```{diagrams} diagram.py
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## Conclusion
|
|
67
|
-
|
|
68
|
-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
|
|
69
|
-
|
|
70
|
-
## References
|
|
71
|
-
|
|
72
|
-
```{bibliography}
|
|
73
|
-
```
|
|
@@ -1 +0,0 @@
|
|
|
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;EAEE;;;;;;IAME;EPuMF;AACF;AOpMA;;EAAA;AAGA;EACE;EAEA;APqMF;;AOnMA;EACE;APsMF;;AAjOA;;;;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@media (max-width: 76rem) {\n // Reduce the margin-bottom on headings in mobile views\n h1,\n h2,\n h3,\n h4,\n h5,\n h6 {\n margin-bottom: 0.5em;\n }\n}\n\n/*\n * Border specififcally for prompts, which act differently than code blocks.\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":""}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|