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

API reference links depends on installation type #46

Closed
CasperWA opened this issue Aug 24, 2022 · 0 comments · Fixed by #47
Closed

API reference links depends on installation type #46

CasperWA opened this issue Aug 24, 2022 · 0 comments · Fixed by #47
Assignees
@CasperWA
Labels
bug Something isn't working GH Workflows Issue/PR related to the callable workflows pre-commit hooks Issue/PR related to pre-commit hooks

Comments

@CasperWA
Copy link
Collaborator

The "links" to Python API modules in the API reference markdown files depends on the installation type. Specifically, whether the package is an editable or regular installation.

This was discovered when using it for CIF-ontology.

A solution would perhaps be to toggle this relative path generation based on a configuration option. This option would also include/exclude an -e when installing the local package for the CI workflow.
@CasperWA CasperWA added bug Something isn't working pre-commit hooks Issue/PR related to pre-commit hooks GH Workflows Issue/PR related to the callable workflows labels Aug 24, 2022
@CasperWA CasperWA self-assigned this Aug 24, 2022
@CasperWA CasperWA mentioned this issue Aug 24, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CasperWA CasperWA

Labels
bug Something isn't working GH Workflows Issue/PR related to the callable workflows pre-commit hooks Issue/PR related to pre-commit hooks
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API reference links corrections SINTEF/ci-cd
1 participant
@CasperWA