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 dependency ex_doc to v0.37.0 #12

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 14, 2025

This PR contains the following updates:

Package Type Update Change
ex_doc (source) dev minor 0.29.1 -> 0.37.0

Release Notes

elixir-lang/ex_doc (ex_doc)

v0.37.0

Compare Source

Thanks to @​liamcmitchell and @​hichemfantar for the extensive contributions in this new release.

  • Enhancements

    • Optimize and parallelize module retriever, often leading to 20x-30x faster docs generation
    • Considerably improve page loading times in the browser
    • Allow customizing search_data for extra pages
    • Use native style for scroll bars
    • Enhance links between extras/pages/guides with padding and hover effects
    • Go to latest goes to the same page if it exists, root otherwise
    • Apply new style and layout for tabs
    • Increase font-weight on sidebar on Apple machines/devices
    • Improve accessibility across deprecation, links, and summaries
    • Add compatibility to Erlang/OTP 28+
    • Rely on the operating system monospace font for unified experience and better load times
    • Introduce "exdoc:loaded" window event to track navigation
    • Support for favicons
  • Bug fixes

    • Move action links out from heading tags

v0.36.1

Compare Source

  • Enhancements
    • Show a progress bar if navigation takes more than 300ms

    • Bug fixes

      • Fix dark mode styling on cheatsheets
      • Ensure the sidebar closes on hosting navigation in mobile

v0.36.0

Compare Source

  • Enhancements
    • Use swup.js for navigation on hosted sites

    • Support :group in documentation metadata for grouping in the sidebar

    • Support :default_group_for_doc in configuration to set the default group for functions, callbacks, and types

    • Add --warnings-as-errors flag to mix docs

    • Bug fixes

      • Fix typespec with (...) -> any()
      • Do not trap tab commands in the search bar

v0.35.1

Compare Source

  • Bug fixes
    • Make sure symlinks are copied from assets directory
    • Discard private functions documented by EDoc

v0.35.0

Compare Source

  • Enhancements
    • Store proglang in searchdata.js

    • Allow searching for atoms inside backticks

    • Add support for nominal types from Erlang/OTP 28

    • Support a new :redirects option which allows configuring redirects in the sidebar

    • Improve warning when referencing type from a private module

    • Rename "Search HexDocs package" modal to "Go to package docs"

    • Support built-in Erlang/OTP apps in "Go to package docs"

    • Bug fixes

      • Switch anchor title to aria-label
      • Convert admonition blockquotes to sections for screen reader users
      • Fix code copy buttons within tabsets

v0.34.2

Compare Source

  • Enhancements
    • Allow anchors on function and callback autolinks

    • Bug fixes

      • Make module attributes searchable without leading @​
      • Make Mod.fun pairs searchable without the arity
      • Do not emit warnings on unary plus in typespecs
      • Add top margin to nested module prefix in sidebar

v0.34.1

Compare Source

  • Enhancements
    • Add a v shortcut to open/focus the version select

    • Compatibility fixes for Elixir v1.17 and Erlang/OTP 27+

    • Bug fixes

      • Do not crash on unknown media types in assets during EPUB generation
      • Fix slight shift on search bar input during focus
      • Avoid unwanted showing/hiding of search bar on mobile when scrolling

v0.34.0

Compare Source

This release requires Elixir v1.13.

  • Enhancements

    • Allow several assets to be copied by passing a map to :assets
    • Improve compatibility when hosting ExDoc on a platform that strips .html
  • Bug fixes

    • Link to the latest version of Erlang/OTP docs
  • Deprecations

    • Deprecate passing a binary to :assets

v0.33.0

Compare Source

  • Enhancements
    • Keep the sidebar light in light mode

v0.32.2

Compare Source

  • Enhancements
    • Allow the modal to close when we click outside the modal content

    • Bug fixes

      • Fix indentation of -spec/-type in Erlang
      • Fix Mix task autolink for tasks with underscores
      • Avoid conflicts between custom headers with tooltips/modals

v0.32.1

Compare Source

  • Bug fixes
    • Add version dropdown back on hexdocs.pm
    • Improve search input styling and scrolling

v0.32.0

Compare Source

  • Enhancements
    • Add the ability to see previews during autocompletion

    • Remove serif font for content and prefer using the operating system font instead

    • Allow the search bar to be focused at any moment

    • Make functions acceptable for :skip_undefined_reference_warnings_on

    • Make functions acceptable for :skip_code_autolink_to

    • Allow using meta tags to disable autocompletion and configure the full text search

    • Bug fixes

      • Fix blockquote padding inside tabset on small screens
      • Consistently index h2 and h3 headers

v0.31.2

Compare Source

  • Enhancements
    • Add equiv handling for types and callbacks for Erlang

    • Add cmd-k/ctrl-k shortcut to focus searchbar

    • Use dark backgrounds for admonition blocks in dark theme

    • Autolink .cheatmd files

    • Warn when extra link targets an application not in dependencies

    • Add support for before_closing_footer_tag

    • Bug fixes

      • Fix sidebar toggle flickering on page load
      • Fix background color inside code snippets with no language in dark mode
      • Hide search bar and background layer on print
      • Use blue links for Erlang
      • Fix logo not declared in EPUB's OPF manifest
      • Escape URIs and titles in EPUB
      • Fix URL slug not updating on anchor clicks

v0.31.1

Compare Source

  • Enhancements
    • Make the sidebar horizontally resizable
    • Show the sidebar button and search bar on scroll up on mobile devices
    • More improvements to Erlang/OTP 27 support
    • Document that source_url_pattern can be a fun
    • Support m:Module#anchor

v0.31.0

Compare Source

  • Enhancements
    • Allow searching atoms, module attributes, and words finishing with ? and !

    • Support upcoming Erlang/OTP 27 documentation format

    • Include prebuilt binaries on every release

    • Add borders dividing table rows in rendered content

    • Add accurate warnings for missing docs from Elixir v1.16+

    • Support e:dep:some-page.md for explicitly linking to a page in a package

    • Support m:SomeModule for explicitly linking to a module

    • Add noindex meta tag to 404 and Search pages

    • Move search to the main content so we can display more results

    • Warn when referencing functions, types, and callbacks from filtered out modules

    • Bug fixes

      • Fix search for words with hyphens in them
      • Fix search for contents inside EEx interpolation

v0.30.9

Compare Source

  • Bug fixes
    • Fix a scenario where invalid assets would be generated

    • Enhancements

      • Add admonition EPUB styles

v0.30.8

Compare Source

  • Bug fixes
    • Fix regression in umbrella applications

v0.30.7

Compare Source

  • Bug fixes
    • Do not crash on EDoc type annotations

    • Do not crash on functions without name

    • Handle remote types in records

    • Fix scrolling to top on iOS

    • Fix invalid output markup for “hover link” headings

    • Enhancements

      • Support any String.Chars as the extra page name
      • Improve screen reader accessibility
      • Add :skip_code_autolink_to option

v0.30.6

Compare Source

  • Enhancements
    • Extract title from Markdown file when preceeded with comments
    • Improve focus navigation in notebooks

v0.30.5

Compare Source

  • Bug fixes
    • Fix style for code in headers
    • Fix search data generation for Erlang/OTP

v0.30.4

Compare Source

  • Bug fixes
    • Fix style for anchors in headers

v0.30.3

Compare Source

  • Enhancements
    • Compress search index before storing in local storage

    • Bug fixes

      • Fix styling for headers on cheatsheets and small screens

v0.30.2

Compare Source

  • Bug fixes
    • Fix escaping in search_data.json
    • Skip vega-lite code blocks in search_data.json

v0.30.1

Compare Source

  • Bug fixes
    • Fix styling for headers on cheatsheets and small screens

v0.30.0

Compare Source

  • Enhancements
    • Support tabsets (see the README for more information)

    • Improve search results and indexing by storing more data and metadata

    • Warn on invalid references in links

    • Strike-through deprecated items on autocompletion

    • Add source URL link to API reference page

    • Allow multiple extra files with the same name by generating unique names in case of conflicts

    • Bug fixes

      • Fix rendering of large code blocks in admonition texts
      • Do not log errors on module mismatch in case-insensitive file systems

v0.29.4

Compare Source

  • Bug fixes
    • Fix sidebar element with no children taking additional padding
    • Fix elements being rendered too thick on macOS
    • Fix rendering of HTML elements inside tooltips

v0.29.3

Compare Source

  • Enhancements
    • Propagate :since metadata from modules

    • Add support for MFAs and maps in before_closing_body_tag and before_closing_head_tag

    • Bug fixes

      • Improve font consistency across different OSes
      • Keep language class on livebook output code block
      • Ensure switches have higher precedence than config

v0.29.2

Compare Source

  • Enhancements
    • Improvements to cheatsheets spacing

    • Improvements to cheatsheets print

    • Include sections of modules and extras in search suggestions

    • Make sidebar links full-width and add hover states

    • Improve clickable area of sidebar tabs

    • Improve contrast on sidebar

    • Bug fix

      • Add media type for .license files for epub
      • Fix overscroll on the sidebar
      • Focus search input immediately after keyboard shortcut
      • Don't attempt parsing code blocks that don't look like modules
      • Fix visited link color in admonition blocks

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title Update dependency ex_doc to v0.36.1 Update dependency ex_doc to v0.37.0 Feb 5, 2025
@renovate renovate bot force-pushed the renovate/ex_doc-0.x-lockfile branch from 00448b5 to 1eaf5bd Compare February 5, 2025 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants