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

Update docs about credentials #609

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Update docs about credentials #609

merged 1 commit into from
Feb 29, 2024

Conversation

jdangerx
Copy link
Contributor

@jdangerx jdangerx commented Feb 28, 2024

Hi! I was trying to use a service account key with GCSFS, which wasn't mentioned in the docs - so I tried it, and it worked, and I think we can make it slightly clearer that it works.

Also, we ran into a silly issue where we had an unexpanded ~ in a path, and assumed that would work - adding some clarification there, too.

Finally, it took a surprising amount of googling to find the Credentials class (which I knew I had worked with before...) so I added a link as well.

I'm not sure if y'all have any RST style requirements but I'm happy to edit any of this to suit your needs!

FWIW - I didn't actually build the docs since a quick make html errored out with:

> make html 
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v7.2.6

Theme error:
no theme named 'sphinx_rtd_theme' found (missing theme.conf?)
make: *** [html] Error 2

And I decided that I should get back to my normal work ;)

@martindurant
Copy link
Member

Thanks for this. The range of possibilities allowed increased slowly with time, and the docs doesn't always keep up :|

@martindurant martindurant merged commit 1658976 into fsspec:main Feb 29, 2024
5 checks passed
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.

2 participants