Merge pull request #114 from mrava87/dev

doc: Migrate doc to pydata-sphinx-theme

Author: mrava87

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "3.9"
   apt_packages:
     - libopenblas-dev
 

Makefile

@@ -40,3 +40,12 @@ doc:
 
 docupdate:
 	cd docs && make html && cd ..
+
+servedoc:
+	$(PYTHON) -m http.server --directory docs/build/html/
+
+lint:
+	flake8 docs/ examples/ pyproximal/ pytests/ tutorials/
+
+typeannot:
+	mypy pyproximal/

docs/source/conf.py

@@ -98,12 +98,12 @@
 .. |year| replace:: {year}
 """.format(year=year)
 
+html_static_path = ["_static"]
 html_last_updated_fmt = '%b %d, %Y'
 html_title = 'PyProximal'
 html_short_title = 'PyProximal'
-html_logo = '_static/pyproximal.png'
-html_favicon = '_static/favicon.ico'
-html_static_path = ['_static']
+html_logo = 'pyproximal.png'
+html_favicon = 'favicon.ico'
 html_extra_path = []
 pygments_style = 'default'
 add_function_parentheses = False
@@ -112,7 +112,7 @@
 html_show_copyright = True
 
 # Theme config
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     'logo_only': True,
     'display_version': True,

requirements-dev.txt

@@ -13,6 +13,7 @@ docutils<0.18
 Sphinx==4.2.0
 sphinx-rtd-theme
 sphinx-gallery
+pydata-sphinx-theme
 numpydoc
 nbsphinx
 image