Insiders: Getting material-mkdocs-insiders into requirements.txt (CI, readthedocs)

[rfay]

I'm able to access material-mkdocs-insiders just fine using pip using the instructions, but was thinking it would be best practice to incorporate it into requirements.txt. Is there a way to do that with an exotic URL like git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git ? Or should it just be installed separately with the pip command? And how is readthedocs going to be able to access it?

[squidfunk]

Jup, it's definitely best practice, but sadly, pip's requirements.txt doesn't allow for environment variables. @StarfallProjects did a write-up on how to deploy Insiders to different providers, but I'm not sure whether readthedocs is included. There are probably other cases where readthedocs needs to build from private repositories with secrets, so maybe ask the maintainers of readthedocs?

[NicolasMassart]

It says only for RTD for business. Have you tried with the RTD.org?

[rfay]

Yes, it worked fine with readthedocs.org - they process it. As a matter of fact, pip3 does in fact process environment variables, and this all works out fine.

[NicolasMassart]

Thanks a lot!

[NicolasMassart]

I have to check if we have a Github machine user to generate a token now...

[NicolasMassart]

I confirm this works like a charm with user token and RTD requirements.txt