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

Workaround for RTD not showing colons for function args #1150

Merged
merged 3 commits into from
Jan 10, 2023

Conversation

ianthomas23
Copy link
Collaborator

Fixes #790 which is that Read the Docs does not display colons between argument names and types.

There is a discussion about this on the sphinx_rtd_theme github readthedocs/sphinx_rtd_theme#766. The workaround here is the one recommended in that issue.

This PR is made on top of #1149 so that RTD will successfully build the docs so the workaround can be checked. Ideally #1149 should be merged before this.

Longer term it might be worth us considering a switch from the RTD theme to one that is more actively maintained. Options that work well for relatively small documentation projects are furo (https://github.com/pradyunsg/furo) and sphinx-book-theme (https://github.com/executablebooks/sphinx-book-theme).

@ianthomas23
Copy link
Collaborator Author

Here is some output from the RTD build showing that the fix works.

Screenshot 2023-01-10 at 12 15 25

@martindurant
Copy link
Member

Perfect, thank you.

@martindurant martindurant merged commit ad0c3c6 into fsspec:master Jan 10, 2023
@ianthomas23 ianthomas23 deleted the 790_rtd_arg_colon branch February 1, 2023 11:32
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.

API docs on RTD meld parameters and types without separator (such as : )
2 participants