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

Improve auto-generation of refs with backticks #67

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

lebrice
Copy link
Collaborator

@lebrice lebrice commented Oct 9, 2024

  • Make it possible to specify some packages to include in a yaml-style
    mkdocs header. backtick refs in that doc file will then be able to
    reference objects in those modules (or objects in that list)

Signed-off-by: Fabrice Normandin [email protected]

@codecov-commenter
Copy link

codecov-commenter commented Oct 9, 2024

Codecov Report

Attention: Patch coverage is 89.47368% with 6 lines in your changes missing coverage. Please review.

Project coverage is 79.53%. Comparing base (7c34f38) to head (57780d7).

Files with missing lines Patch % Lines
project/utils/autoref_plugin.py 88.37% 5 Missing ⚠️
project/utils/hydra_config_utils.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #67      +/-   ##
==========================================
+ Coverage   79.40%   79.53%   +0.13%     
==========================================
  Files          61       61              
  Lines        3598     3646      +48     
==========================================
+ Hits         2857     2900      +43     
- Misses        741      746       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Make it possible to specify some packages to include in a yaml-style
  mkdocs header. `backtick` refs in that doc file will then be able to
  reference objects in those modules (or objects in that list)

Signed-off-by: Fabrice Normandin <[email protected]>
@lebrice lebrice force-pushed the lebrice/improve-autorefs-generation branch from 2966b51 to 57780d7 Compare October 11, 2024 16:24
@lebrice lebrice merged commit a5acd0b into master Oct 11, 2024
7 checks passed
@lebrice lebrice deleted the lebrice/improve-autorefs-generation branch October 11, 2024 17:44
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.

2 participants