add logo and make consts.py private

Author: skysomorphic

docs/_static/favicon.ico

@@ -9,7 +9,6 @@ Submodules
 
    qbreader.api_utils
    qbreader.asynchronous
-   qbreader.consts
    qbreader.synchronous
    qbreader.types
 

docs/_static/logo.png

@@ -13,9 +13,9 @@
 
 sys.path.insert(0, path.abspath(".."))
 
-project = 'python-qbreader'
-copyright = '2023, Sky Hong, Rohan Arni, Geoffrey Wu'
-author = 'Sky Hong, Rohan Arni, Geoffrey Wu'
+project = "python-qbreader"
+copyright = "2023, Sky Hong, Rohan Arni, Geoffrey Wu"
+author = "Sky Hong, Rohan Arni, Geoffrey Wu"
 release = qbreader.__version__
 
 # -- General configuration ---------------------------------------------------
@@ -28,16 +28,18 @@
     "sphinx.ext.napoleon",
 ]
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 default_role = "py:obj"
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
-html_static_path = ['_static']
+html_theme = "furo"
+html_favicon = "_static/favicon.ico"
+html_logo = "_static/logo.png"
+html_static_path = ["_static"]
 
 intersphinx_mapping = {
     "py": ("https://docs.python.org/3", None),

docs/api/qbreader.consts.rst

@@ -5,7 +5,7 @@
 import aiohttp
 
 import qbreader.api_utils as api_utils
-from qbreader.consts import BASE_URL
+from qbreader._consts import BASE_URL
 from qbreader.types import (
     AnswerJudgement,
     Bonus,

docs/api/qbreader.rst

@@ -5,7 +5,7 @@
 import requests
 
 import qbreader.api_utils as api_utils
-from qbreader.consts import BASE_URL
+from qbreader._consts import BASE_URL
 from qbreader.types import (
     AnswerJudgement,
     Bonus,

docs/conf.py

@@ -9,7 +9,7 @@
 import aiohttp
 import requests
 
-from qbreader.consts import BASE_URL
+from qbreader._consts import BASE_URL
 
 
 class Category(enum.StrEnum):

qbreader/consts.py qbreader/_consts.pyqbreader/consts.py renamed to qbreader/_consts.py

@@ -32,6 +32,14 @@ allowlist_externals = poetry
 commands =
     poetry run mypy --no-incremental .
 
+[testenv:docs]
+description = build docs
+allowlist_externals = poetry, rm
+commands =
+    rm -rf docs/api
+    sphinx-apidoc -Tefo docs/api qbreader
+    poetry run sphinx-build -TE -b html -d docs/_build/doctrees docs docs/_build
+
 [flake8]
 max_line_length = 88
 exclude =