Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: e7aac2f
Choose a base ref
...
head repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 39de5db
Choose a head ref
  • 13 commits
  • 33 files changed
  • 2 contributors

Commits on Apr 28, 2023

  1. chore: Template upgrade

    pawamoy committed Apr 28, 2023
    Configuration menu
    Copy the full SHA
    c1aea6e View commit details
    Browse the repository at this point in the history

Commits on May 1, 2023

  1. docs: Re-organize docs a bit

    pawamoy committed May 1, 2023
    Configuration menu
    Copy the full SHA
    d37a137 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6e849e3 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    4115500 View commit details
    Browse the repository at this point in the history
  4. chore: Template upgrade

    pawamoy committed May 1, 2023
    Configuration menu
    Copy the full SHA
    286c83c View commit details
    Browse the repository at this point in the history
  5. chore: Template upgrade

    pawamoy committed May 1, 2023
    Configuration menu
    Copy the full SHA
    ca78588 View commit details
    Browse the repository at this point in the history

Commits on May 11, 2023

  1. chore: Template upgrade

    pawamoy committed May 11, 2023
    Configuration menu
    Copy the full SHA
    028a802 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    45f8904 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    47afbf6 View commit details
    Browse the repository at this point in the history
  4. refactor: Report inventory loading errors

    Issue #157: #517
    PR #568: #568
    
    Co-authored-by: Oleh Prypin <oleh@pryp.in>
    pawamoy and oprypin authored May 11, 2023
    Configuration menu
    Copy the full SHA
    2c05d78 View commit details
    Browse the repository at this point in the history

Commits on May 20, 2023

  1. Configuration menu
    Copy the full SHA
    c9f99bc View commit details
    Browse the repository at this point in the history

Commits on May 24, 2023

  1. feat: Allow extensions to add templates

    An extension here is simply a Python package
    that defines an entry-point for a specific handler.
    
    For example, an extension can add templates to the Python handler
    thanks to this entry-point:
    
    ```toml
    [project.entry-points."mkdocstrings.python.templates"]
    extension-name = "extension_package:get_templates_path"
    ```
    
    This entry-point assumes that the extension provides
    a `get_templates_path` function directly under
    the `extension_package` package. This function doesn't
    accept any argument and returns the path to a directory
    containing templates. The directory must contain one
    subfolder for each supported theme, for example:
    
    ```
    templates/
        material/
        readthedocs/
        mkdocs/
    ```
    
    mkdocstrings will add the folders corresponding
    to the user-selected theme, and to the handler's defined
    fallback theme, as usual, to the Jinja loader.
    
    The names of the extension templates must not
    overlap with the handler's original templates.
    
    The extension is then responsible, in collaboration
    with its target handler, for mutating the collected
    data in order to instruct the handler to use one of
    the extension template when rendering particular objects.
    
    For example, the Python handler will look for a `template`
    attribute on objects, and use it to render the object.
    This `template` attribute will be set by Griffe extensions
    (Griffe is the tool used by the Python handler to collect data).
    
    PR #569: #569
    pawamoy authored May 24, 2023
    Configuration menu
    Copy the full SHA
    cf0af05 View commit details
    Browse the repository at this point in the history

Commits on May 26, 2023

  1. chore: Prepare release 0.22.0

    pawamoy committed May 26, 2023
    Configuration menu
    Copy the full SHA
    39de5db View commit details
    Browse the repository at this point in the history
Loading