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.

Sign up for GitHub

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

Jump to bottom

Fix for admonitions being displayed out of their original context. #910

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fix for admonitions being displayed out of their original context. #910

wants to merge 6 commits into from

Commits on Apr 27, 2023

  1. Removes 'pullup' for admonitions in detailed description to keep them… 

    … in context.

Signed-off-by: Putnam, Kevin <[email protected]>

Changes to be committed:
	modified:   breathe/renderer/sphinxrenderer.py
    @intelkevinputnam
    intelkevinputnam committed Apr 27, 2023
    Configuration menu
    Copy the full SHA
    4da1677 View commit details
    Browse the repository at this point in the history

Commits on May 24, 2023

  1. Adds ability to toggle pullups for notes, warnings, and field_lists i… 

    …n detailed descriptions.

TODO:

Determine method for toggling whether to pull them up for different object types.

Signed-off-by: Putnam, Kevin <[email protected]>
    @intelkevinputnam
    intelkevinputnam committed May 24, 2023
    Configuration menu
    Copy the full SHA
    7ffb895 View commit details
    Browse the repository at this point in the history

Commits on May 25, 2023

  1. Adds ability to define pull up behavior based on the Breathe directiv… 

    …e used eg. doxygenpage.

Syntax: breathe_detaileddesc_pullup_types = {"doxygenpage":["note","warning"]}

Signed-off-by: Putnam, Kevin <[email protected]>
    @intelkevinputnam
    intelkevinputnam committed May 25, 2023
    Configuration menu
    Copy the full SHA
    3e9f5e7 View commit details
    Browse the repository at this point in the history

  2. Removes lint flagged comment. 

    Signed-off-by: Putnam, Kevin <[email protected]>
    @intelkevinputnam
    intelkevinputnam committed May 25, 2023
    Configuration menu
    Copy the full SHA
    c3aac6a View commit details
    Browse the repository at this point in the history

  3. Fixes linter flagged line length. 

    Signed-off-by: Putnam, Kevin <[email protected]>
    @intelkevinputnam
    intelkevinputnam committed May 25, 2023
    Configuration menu
    Copy the full SHA
    a1e9f37 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2023

  1. Adds cast for context. 

    Signed-off-by: Putnam, Kevin <[email protected]>
    @intelkevinputnam
    intelkevinputnam committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    cb9fdbc View commit details
    Browse the repository at this point in the history