From ad0c3c6d7820b5ef92e3aa1abc3ea0a6efb443b4 Mon Sep 17 00:00:00 2001 From: Ian Thomas Date: Tue, 10 Jan 2023 14:26:07 +0000 Subject: [PATCH] Workaround for RTD not showing colons for function args (#1150) * Remove unwanted fsspec_loop link in docs * Fix readthedocs config * Workaround for RTD not showing colons for function args --- docs/source/_static/custom.css | 5 +++++ docs/source/async.rst | 2 -- docs/source/conf.py | 6 +++++- readthedocs.yml | 3 +-- 4 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 docs/source/_static/custom.css diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 000000000..16fffc59d --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,5 @@ +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} diff --git a/docs/source/async.rst b/docs/source/async.rst index 668c871a3..555190c23 100644 --- a/docs/source/async.rst +++ b/docs/source/async.rst @@ -147,5 +147,3 @@ available as the attribute ``.loop``. .. autofunction:: fsspec.asyn.sync_wrapper .. autofunction:: fsspec.asyn.get_loop - -.. autofunction:: fsspec.asyn.fsspec_loop diff --git a/docs/source/conf.py b/docs/source/conf.py index 027bad0d6..d916fd0f5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -114,7 +114,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] +html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -128,6 +128,10 @@ ] } +# Custom CSS file to override read the docs default CSS. +# Contains workaround for issue #790. +html_css_files = ["custom.css"] + # -- Options for HTMLHelp output ------------------------------------------ diff --git a/readthedocs.yml b/readthedocs.yml index bfae632b8..f44c84ca8 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -13,7 +13,6 @@ python: - method: pip path: . - sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py fail_on_warning: true