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
fsspec · Jan 10, 2023 · ad0c3c6 · ad0c3c6
1 parent 2eaa57a
commit ad0c3c6
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/docs/source/_static/custom.css 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
@@ -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
@@ -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
@@ -13,7 +13,6 @@ python:
     - method: pip
       path: .
 
-
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
   fail_on_warning: true
Original file line number	Diff line number	Diff line change
Expand Up		@@ -147,5 +147,3 @@ available as the attribute ``.loop``.
		.. autofunction:: fsspec.asyn.sync_wrapper

		.. autofunction:: fsspec.asyn.get_loop

		.. autofunction:: fsspec.asyn.fsspec_loop