Skip to content

How to pass private config vars to RTD? #5007

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

Closed
byrnereese opened this issue Dec 15, 2018 · 1 comment
Closed

How to pass private config vars to RTD? #5007

byrnereese opened this issue Dec 15, 2018 · 1 comment

Comments

@byrnereese
Copy link

byrnereese commented Dec 15, 2018

Details

Problem Description

I recently created a mkdocs plugin (https://github.com/byrnereese/mkdocs-git-committers-plugin) that will display a list of contributors associated with a documentation page. It used the Github API which has aggressive API rate limits unless you are auth'ed with a token.

So I created a token, and added it to my docs mkdocs.yml file under the plugin config. This is obviously far from ideal.

Is there a way to pass these types of values in through an ENV (environment variable) to RTD so that I do not need to reveal these auth tokens publicly?

@stsewd
Copy link
Member

stsewd commented Dec 15, 2018

Currently, there isn't, but it's on plans #4899

@stsewd stsewd closed this as completed Dec 15, 2018
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

2 participants