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: 0.18.1
Choose a base ref
...
head repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 0.19.0
Choose a head ref
  • 15 commits
  • 20 files changed
  • 3 contributors

Commits on Mar 1, 2022

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

Commits on Apr 9, 2022

  1. refactor: Deprecate BaseCollector and BaseRenderer

    The BaseCollector and BaseRenderer are merged into
    the BaseHandler (as mixins for now).
    Developers are still able to create collectors
    and renderers using these deprecated base classes,
    and pass instances of them when creating their handler.
    
    All the methods of the deprecated bases can now
    be defined on the BaseHandler subclass itself.
    Handlers can then be instantiated by passing
    the handler's name, the theme and the optional
    custom templates folder name/path.
    
    Reasoning: often times, the renderer and the collector
    need to communicate or share data. For example,
    the Crystal renderer uses the collector to lookup names
    when creating cross-references. The Python handlers
    are able to filter members when collecting/returning data,
    and need the same members list when rendering,
    to order the elements based on that list.
    
    This change is the first of two, where the second change
    will deprecate the use of `selection` and `rendering` keys
    in the YAML options or MkDocs configuration, in favor of
    a single `options` key that both the collection and rendering
    process will share.
    pawamoy committed Apr 9, 2022
    Configuration menu
    Copy the full SHA
    eb822cb View commit details
    Browse the repository at this point in the history

Commits on Apr 10, 2022

  1. docs: Fix Windows support in automatic code reference recipe

    Co-authored-by: Oleh Prypin <oleh@pryp.in>
    Issue #418: #418
    PR #419: #419
    johnthagen and oprypin authored Apr 10, 2022
    Configuration menu
    Copy the full SHA
    78e11fa View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c4c51cd View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    9055d58 View commit details
    Browse the repository at this point in the history

Commits on Apr 20, 2022

  1. refactor: Deprecate 'selection' and 'rendering' YAML keys

    As seen in commit eb822cb, the separation of
    the selection/collection and rendering configuration
    is problematic. This commit further reduces this
    separation by merging the two current YAML keys
    'selection' and 'rendering' into a single
    'options' key. It means both the 'collect' and
    'render' methods have access to every option.
    
    The old keys can still be used, but are deprecated,
    and therefore a deprecation warning is emitted
    if these keys are found in either global or local
    configurations.
    
    PR #420: #420
    pawamoy authored Apr 20, 2022
    Configuration menu
    Copy the full SHA
    3335310 View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2022

  1. feat: Pass config file path to handlers

    This is to allow handlers to build potential paths
    (like Python search paths) relative to the MkDocs
    configuration file path instead of the current
    working directory. Without it, the build becomes
    dependent on the CWD, breaking the --config-file
    option.
    
    Issue #311: #311
    PR #425: #425
    pawamoy authored Apr 25, 2022
    Configuration menu
    Copy the full SHA
    cccebc4 View commit details
    Browse the repository at this point in the history

Commits on Apr 30, 2022

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

Commits on May 6, 2022

  1. chore: Template upgrade

    pawamoy committed May 6, 2022
    Configuration menu
    Copy the full SHA
    5d3250f View commit details
    Browse the repository at this point in the history

Commits on May 8, 2022

  1. Configuration menu
    Copy the full SHA
    c20022e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7c71f26 View commit details
    Browse the repository at this point in the history
  3. docs: Add logo

    oprypin authored May 8, 2022
    Configuration menu
    Copy the full SHA
    aa77b9c View commit details
    Browse the repository at this point in the history

Commits on May 26, 2022

  1. docs: Update docs

    pawamoy authored May 26, 2022
    Configuration menu
    Copy the full SHA
    624e712 View commit details
    Browse the repository at this point in the history

Commits on May 28, 2022

  1. Configuration menu
    Copy the full SHA
    0a9daf2 View commit details
    Browse the repository at this point in the history
  2. chore: Prepare release 0.19.0

    pawamoy committed May 28, 2022
    Configuration menu
    Copy the full SHA
    5c0e4d1 View commit details
    Browse the repository at this point in the history
Loading