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

Use read the docs v2 config #697

Merged
merged 6 commits into from
Feb 2, 2023
Merged

Use read the docs v2 config #697

merged 6 commits into from
Feb 2, 2023

Conversation

ianthomas23
Copy link
Contributor

Second attempt at using RTD v2 config, auto building on RTD site.

@martindurant
Copy link
Member

I don't see a new build on the s3fs dashboard of RTD

@martindurant
Copy link
Member

Screen Shot 2023-02-01 at 10 44 12

@ianthomas23
Copy link
Contributor Author

A bit of googling says that "resyncing the webhooks" might help. I don't know from which end (github, RTD) this can be done. Maybe both?

@martindurant
Copy link
Member

Try again now? I also clicked a "PR" button in the github webhook config. I think it will now kick off a build, but I still need to find this setting for the thing to get reported.

@martindurant
Copy link
Member

(nvm, privacy is off by default for "free" use)

@martindurant
Copy link
Member

I also re-added the RTD oauth to my github account, which should be enough for RTD to report back.

@ianthomas23
Copy link
Contributor Author

Docs build is working this time!

@martindurant
Copy link
Member

This is good to go?

@ianthomas23
Copy link
Contributor Author

Not quite, there are some warnings I'd like to deal with whilst this is all fresh in my mind. I'll ping you when it is ready.

@ianthomas23
Copy link
Contributor Author

This is good to go now. Rendered output is here: https://s3fs--697.org.readthedocs.build/en/697/index.html

Summary of changes:

  1. Fixes spaces between attribute names and types (fixes Add more s3 fs schemes (s3a://) #269).
  2. Fixes display of bullets points in changelog.
  3. Updates RTD build system to give better control over version of python and dependencies, solution follows that of fsspec.
  4. Treats all warnings as errors causing the doc build to fail, so we can't ignore warnings from now on.
  5. Fixes a few minor warnings.
  6. Switches from using numpydoc to sphinx.ext.napoleon which accepts numpydoc-style docstrings and also correctly deals with class members inherited from base classes in fsspec.

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