book docs

docs/book/_config.yml

@@ -0,0 +1,64 @@
+####################################################
+# Book settings
+title                    : CGE
+author                   : Jason DeBacker
+copyright                : '2024'
+# logo                     : ""
+
+####################################################
+# Execution settings
+execute:
+  execute_notebooks      : force
+
+####################################################
+# HTML-specific settings
+html:
+  # favicon                : "_static/logo/favicon.ico"  # generated at https://www.favicon.cc/
+  use_edit_page_button   : false  # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
+  use_repository_button  : true  # Whether to add a link to your repository button
+  use_issues_button      : true  # Whether to add an "open an issue" button
+  extra_navbar           : Powered by <a href="https://jupyterbook.org">Jupyter Book</a>  # Will be displayed underneath the left navbar.
+  # extra_footer           : ""  # Will be displayed underneath the footer.
+  # google_analytics_id    : ""  # A GA id that can be used to track book views.
+  home_page_in_navbar    : true  # Whether to include your home page in the left Navigation Bar
+  # baseurl                : ""  # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
+
+####################################################
+# Launch button settings
+notebook_interface       : 'notebook'
+
+binder:
+  binderhub_url          : 'https://mybinder.org'
+  text                   : 'Launch binder'
+
+launch_buttons:
+  notebook_interface     : 'classic'  # The interface interactive links will activate ["classic", "jupyterlab"]
+  # binderhub_url          : https://mybinder.org  # The URL of the BinderHub (e.g., https://mybinder.org)
+  # jupyterhub_url         : ""  # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
+  # thebelab               : false  # Add a thebelab button to pages (requires the repository to run on Binder)
+
+####################################################
+# Information about where the book exists on the web
+repository:
+  url                    : https://github.com/PSLmodels/CGE
+  path_to_book           : 'docs/book'
+
+#######################################################################################
+# Advanced and power-user settings
+sphinx:
+  extra_extensions          : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
+                               'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
+                               'alabaster']   # A list of extra extensions to load by Sphinx.
+  config                    :   # key-value pairs to directly over-ride the Sphinx configuration
+    bibtex_reference_style: author_year
+    mathjax_path          : https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+####################################################
+# LaTeX information
+latex:
+  latex_engine           : 'xelatex'
+  latex_documents:
+    targetname           : book.tex
+# bibtex_bibfiles:
+#    - references.bib
+#    - citations.bib

docs/book/_toc.yml

@@ -0,0 +1,9 @@
+format: jb-book
+root: content/intro/index
+parts:
+- caption: Contributing to CGE
+  chapters:
+  - file: content/intro/contributor_guide
+- caption: CGE API
+  chapters:
+  - file: content/api/public_api

docs/book/content/intro/contributor_guide.rst

@@ -17,7 +17,7 @@ Setup Python
 -------------
 
 Open CGE is written in the Python programming language.
-Download and install the free Anaconda distribution of Python 3.6 from
+Download and install the free Anaconda distribution of Python 3.10+ from
 `Anaconda`_.  You must do this even if you already have
 Python installed on your computer because the Anaconda distribution
 contains additional Python packages that are used by Open CGE (many of