From 8a6da6d06de67e16e1b4f29bf2dc15331d35c18d Mon Sep 17 00:00:00 2001 From: Daniel Silva Date: Sat, 1 Jun 2024 20:27:59 +0000 Subject: [PATCH] style: update comments in docs/conf.py --- docs/source/conf.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 2081c11..1e69874 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,7 +43,6 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# html_theme = 'alabaster' html_theme = 'furo' html_static_path = ['_static'] html_title = 'semanticscholar' @@ -54,7 +53,7 @@ # -- Options for autodoc ----------------------------------------------------- autodoc_member_order = 'groupwise' -# --- API Endpoints --- +# -- API Endpoints ----------------------------------------------------------- api_endpoints = dict() className = 'SemanticScholar' @@ -93,7 +92,7 @@ api_file.write(api_file_contents) api_file.close() -# --- SemanticScholar objects --- +# -- SemanticScholar objects ------------------------------------------------- def find_subclasses(module, base_class): '''Return all subclasses of a base class within a module.''' @@ -150,7 +149,7 @@ def find_subclasses(module, base_class): s2object_file.write('\t:members:\n') s2object_file.write('\t:inherited-members:\n') -# --- Changelog --- +# -- Changelog --------------------------------------------------------------- with open('../../CHANGELOG.md', 'r', encoding='utf-8') as changelog_file: changelog = changelog_file.read()