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

API reference links corrections #47

Merged
merged 3 commits into from
Aug 24, 2022
Merged

Conversation

CasperWA
Copy link
Collaborator

Fixes #46

Introduces the relative input for relevant workflows as well as the --relative option for the docs-api-reference pre-commit hook.

The point of this input/option is to toggle whether or not to install the local Python package(s) as an editable installation (using the -e option for pip install) and creating the API reference markdown links into the Python API relative to the repository root or the importable Python package name.

@codecov-commenter
Copy link

codecov-commenter commented Aug 24, 2022

Codecov Report

Merging #47 (71f02ec) into main (0927de8) will increase coverage by 0.19%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #47      +/-   ##
==========================================
+ Coverage   50.19%   50.39%   +0.19%     
==========================================
  Files           3        3              
  Lines         255      256       +1     
==========================================
+ Hits          128      129       +1     
  Misses        127      127              
Impacted Files Coverage Δ
ci_cd/tasks.py 50.40% <100.00%> (+0.19%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@CasperWA CasperWA merged commit aba41e5 into main Aug 24, 2022
@CasperWA CasperWA deleted the cwa/fix-46-api-reference-links branch August 24, 2022 08:29
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.

API reference links depends on installation type
2 participants