minor docs redesign

cvxgrp · May 12, 2024 · 53d7c8f · 53d7c8f
1 parent 2167851
commit 53d7c8f
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 14 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,19 @@
+.. _api-documentation-page:
+
+API documentation
+=================
+
+.. toctree::
+
+    simulator
+    policies
+    returns
+    risks
+    costs
+    constraints
+    result
+    data
+    internals
+
+.. py:module:: cvxportfolio
+    :noindex:
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,7 +24,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Cvxportfolio'
-copyright = '2023, The Cvxportfolio Authors'
+copyright = '2024, The Cvxportfolio Authors'
 author = 'The Cvxportfolio Authors'
 
 # The full version, including alpha/beta/rc tags
@@ -105,7 +105,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'furo'
+html_theme = 'pydata_sphinx_theme'
 
 # not used by FURO
 # html_theme_options = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -78,21 +78,13 @@ Table of Contents
 -----------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    manual
-   simulator
-   policies
-   returns
-   risks
-   costs
-   constraints
-   result
-   data
-   internals
+   api
    examples
    contributing
 
 .. _paper: _static/cvx_portfolio.pdf
 .. _FRED: https://fred.stlouisfed.org/
-.. _Yahoo Finance: https://finance.yahoo.com
+.. _Yahoo Finance: https://finance.yahoo.com
diff --git a/pyproject.toml b/pyproject.toml
@@ -13,7 +13,7 @@ dependencies = ["pandas", "numpy", "matplotlib", "requests", "cvxpy",
     ]
 
 [project.optional-dependencies]
-docs = ["sphinx", "furo", "sphinx-github-style"]
+docs = ["sphinx", "pydata_sphinx_theme", "sphinx-github-style"]
 dev = ["build", "twine", "diff_cover", "pylint", "isort",
     "autopep8", "docformatter", "beautifulsoup4"]
 examples = ['beautifulsoup4', 'lxml', 'clarabel', 'ecos']