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

Question: How to build docs that have other private github dependencies #82

Open
EdgyEdgemond opened this issue Mar 2, 2021 · 1 comment

Comments

@EdgyEdgemond
Copy link

There are potentially two issues at play here.

When I build docs that have no dependencies they can't reference the local modules (for autodoc pieces), to get around this i've added . to requirements.txt and it works fine. Is there something I have missed that would allow it to reference the local modules without having to explicitly install them?

And if not, we provide an SSH key when we are pip installing our repos with dependencies, the SSH key has access to the dependencies.

When using this action it installs inside the alpine docker container, and has no way to access the SSH key, is there a way to provide custom env vars to the docker image so it has access to them when installing?

@ghost
Copy link

ghost commented Mar 2, 2021

@EdgyEdgemond according to the Python documentation you should be able to use the GitHub token in your requirements.txt to access private documentation:

git+https://${GITHUB_TOKEN}@github.com/user/project.git@{version}

See also the pip documentation. Alternatively, you can create a Personal Access Token to access these repositories.

if you want to use a Python module that is in the same repository you can use this solution:

./path/to/your/module

Needless to say, it needs to be a proper module that pip can install.

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

No branches or pull requests

1 participant