Update doc theme and formatting

ballroombookkeeper · Nov 4, 2023 · 7176a83 · 7176a83
1 parent 9a79aee
commit 7176a83
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,5 +35,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'python_docs_theme'
 html_static_path = ['_static']
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,4 +1,5 @@
 pytest
 sphinx
 sphinx-autodoc-typehints
+python-docs-theme
 wheel
diff --git a/src/dancesport_parser/o2cm/parser.py b/src/dancesport_parser/o2cm/parser.py
@@ -15,9 +15,9 @@
 def parseMain(htmlDOM: BeautifulSoup = None, rawHtml: str = None) -> List[Competition]:
     """Parse o2cm main results screen, i.e. results.o2cm.com.
     
-    Keyword arguments:
-    htmlDOM -- HTML contents to parse.
-    rawHtml -- If `htmlDOM` is unspecified, raw string to directly parse.
+    :param htmlDOM: HTML contents to parse.
+    :param rawHtml: If `htmlDOM` is unspecified, raw string to directly parse.
+    :return: List of Competitions parsed from HTML
     """
     if htmlDOM is None and rawHtml is None:
         raise RuntimeError("Expected either htmlDOM or rawHtml to be provided.")