sphinx

.github/hello-world/book/sphinx/_static/custom.css

@@ -0,0 +1 @@
+.wy-nav-content { max-width: 100% }

.github/hello-world/book/sphinx/conf.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+project = ".github"
+
+master_doc = "index"
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
+extensions = [
+    "sphinx.ext.viewcode",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "autoapi.extension",
+]
+
+
+source_dir = "cvx"
+autoapi_type = "python"
+autoapi_dirs = [f"../../{source_dir}"]
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "private-members",
+    "show-module-summary",
+    "special-members",
+    "imported-members",
+]
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+
+# HTML -----------------------------------------------------------------
+# html_favicon = "_static/logo.jpeg"
+# html_logo = "_static/logo.jpeg"
+html_title = ".github Documentation"
+html_show_sourcelink = True
+html_css_files = [
+    "custom.css",
+]
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

.github/hello-world/book/sphinx/index.rst

@@ -0,0 +1,20 @@
+.. rst-class:: hide-header
+
+
+.. image:: _static/logo.jpeg
+    :align: center
+
+
+.. toctree::
+   :maxdepth: 3
+
+   ../../README.md
+   license
+
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 3
+
+   autoapi/index

.github/hello-world/book/sphinx/license.rst

@@ -0,0 +1,4 @@
+License
+=======
+
+Copyright (c) 2023 Stanford University Convex Optimization Group