book construction

CONTRIBUTING.md

@@ -42,7 +42,7 @@ Python versions and different platforms. If these tests start failing, please
 fix your code and send another commit, which will re-trigger the tests.
 
 If you'd like to add a new feature to cvxrisk, please do propose your
-change on a Github issue, to make sure that your priorities align with ours.
+change on a GitHub issue, to make sure that your priorities align with ours.
 
 If you'd like to contribute code but don't know where to start, try one of the
 following:

book/_config.yml

@@ -11,20 +11,15 @@ execute:
 
 parse:
   myst_enable_extensions:
-    - substitution
     - linkify
     - dollarmath
-  myst_substitutions:
-    book_url: https://www.cvxgrp.org/cvxrisk
-
 
 # needed for plotly
 sphinx:
   config:
     html_js_files:
     - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
 
-
 # Information about where the book exists on the web
 repository:
   url: https://github.com/cvxgrp/cvxrisk

book/docs/api.md

@@ -2,4 +2,4 @@
 
 ## Sphinx
 
-{{ '[API]({url}/sphinx/)'.format(url=book_url) }}
+[API](https://www.cvxgrp.org/cvxrisk/sphinx/)

book/docs/reports.md

@@ -2,8 +2,8 @@
 
 ## Timing
 
-{{ '[Report]({url}/tests/html-report/report.html)'.format(url=book_url) }}
+[Report](https://www.cvxgrp.org/cvxrisk/tests/html-report/report.html)
 
 ## Coverage
 
-{{ '[Coverage]({url}/tests/html-coverage/index.html)'.format(url=book_url) }}
+[Coverage](https://www.cvxgrp.org/cvxrisk/tests/html-coverage/index.html)

book/sphinx/conf.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-master_doc = "index"
 project = "cvxrisk"
 
+master_doc = "index"
+
 source_suffix = {
     ".rst": "restructuredtext",
     ".md": "markdown",
@@ -15,9 +16,10 @@
     "autoapi.extension",
 ]
 
-source_dirs = "cvx"
+
+source_dir = "cvx"
 autoapi_type = "python"
-autoapi_dirs = [f"../../{ source_dirs }"]
+autoapi_dirs = [f"../../{source_dir}"]
 autoapi_options = [
     "members",
     "undoc-members",
@@ -32,8 +34,8 @@
 napoleon_numpy_docstring = True
 
 # HTML -----------------------------------------------------------------
-html_favicon = "_static/logo.jpeg"
-html_logo = "_static/logo.jpeg"
+# html_favicon = "_static/logo.jpeg"
+# html_logo = "_static/logo.jpeg"
 html_title = "cvxrisk Documentation"
 html_show_sourcelink = True
 html_css_files = [