Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documenteer[technote] requirement from <1 to <2 #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Aug 5, 2024

Updates the requirements on documenteer[technote] to permit the latest version.

Release notes

Sourced from documenteer[technote]'s releases.

1.4.0

New features

  • 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).

What's Changed

Full Changelog: lsst-sqre/documenteer@1.3.0...1.4.0

Changelog

Sourced from documenteer[technote]'s changelog.

1.4.0 (2024-07-11)

New features

  • 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).

1.3.0 (2024-05-03)

New features

  • Added a [sphinx.redirects] table to documenteer.toml. This provides support for configuring page redirects from the TOML configuratin. Redirects are useful if pages move because of a content re-organization. This feature is based on sphinx-rediraffe.

  • Added the sphinxcontrib-youtube for embedded YouTube and Vimeo videos into documentation pages. This extension is available for both user guides (documenteer.conf.guide) and technotes (documenteer.conf.technotes).

Bug fixes

  • Technotes ignore files in the repository with .md, .rst, and .ipynb extensions if they aren't the index file. Since technotes are single-page documents, only the index file should be used as a source file. This change lets authors include auxiliary notebooks with their technotes without having to explicitly exclude them from the technote build process. This is implemented with technote.conf.extend_excludes_for_non_index_source.

  • In documenteer.ext.lssttasks, attempt to import _pseudo_parse_arglist from sphinx.domains.python._annotations before falling back to the sphinx.domains.python module. Ultimately this is a workaround.

  • Fix setting the rebuild condition for the documenteer.ext.githubbibcache extension.

  • Fixed the monospace text baseline alignment issue in Safari for technotes by updating to technote 0.8.0. In this version, the font size of the code is set to be 0.9em so that the browser doesn't push the text below the baseline in case its larger than the Source Sans body text. This version also changes the font size on the html element to 100% and instead increases the baseline body text size to 1.1rem on the body element. This change should help technotes respect the user's browser font size settings while also making the rem unit work as expected.

Other changes

  • Added defusedxml as a dev dependency. This is used by Sphinx's sphinx.testing.fixtures, but isn't included as a dependency by Sphinx itself. This change ensures that defusedxml is installed when running the tests.

1.2.2 (2024-04-11)

Bug fixes

  • Update jira_uri_template configuration default to https://rubinobs.atlassian.net/browse/{issue}. This will make all :jira:, :jirab:, and :jirap: roles point to the new Jira instance for Rubin Observatory.
  • Drop jira.lsstcorp.org from the linkcheck ignore list defaults for documenteer.config.guide since that instance is no longer being used.
  • Replace jira.lsstcorp.org URLs in documentation to rubinobs.atlassian.net.

1.2.1 (2024-04-02)

Bug fixes

  • Fix the "Source parser for markdown not registered" error for Markdown-based technotes. With the MyST-NB extension the Markdown parser is automatically registered, so the documenteer.conf.technote configuration now resets the source_suffix configuration originally created by the Technote package.

1.2.0 (2024-03-26)

New features

... (truncated)

Commits
  • 8d2bb24 Merge pull request #228 from lsst-sqre/tickets/DM-44542
  • ae53608 Update change log for 1.4.0 release
  • 7a4b618 Add documentation on using technote-wide-content
  • 6252fc7 Extend test cases for markdown technote
  • 68ee146 Drop header margin tweaks
  • ece778c Update technote to 0.9
  • 2ca5819 Update page-redirects.rst
  • 167a83d Merge pull request #226 from lsst-sqre/tickets/DM-44193
  • 0f027a1 Prepare for 1.3.0 release
  • b025f05 Add sphinxcontrib-youtube to guides and technotes
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [documenteer[technote]](https://github.com/lsst-sqre/documenteer) to permit the latest version.
- [Release notes](https://github.com/lsst-sqre/documenteer/releases)
- [Changelog](https://github.com/lsst-sqre/documenteer/blob/main/CHANGELOG.md)
- [Commits](lsst-sqre/documenteer@0.1.0...1.4.0)

---
updated-dependencies:
- dependency-name: documenteer[technote]
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants