First version of new doc.

tomsch420 · Jun 26, 2024 · 41f33ba · 41f33ba
1 parent 9c9d232
commit 41f33ba
Show file tree

Hide file tree

Showing 28 changed files with 269 additions and 671 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,4 @@ doc/build
 
 src/probabilistic_model.egg-info
 build
-book/_build
+doc/_build
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -12,16 +12,19 @@ build:
     python: "3.9"
   apt_packages:
     - graphviz
+  jobs:
+    pre_build:
+      # Generate the Sphinx configuration for this Jupyter Book so it builds.
+      - "jupyter-book config sphinx doc/"
 
-
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-  configuration: doc/conf.py
-
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
-    - requirements: doc/requirements.txt
+    - requirements: doc/requirements.txt
+    - requirements: requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+      - sphinx
+
+sphinx:
+  builder: html
diff --git a/book/graphical_models.md b/book/graphical_models.md
diff --git a/book/references.bib b/book/references.bib
diff --git a/book/requirements.txt b/book/requirements.txt
diff --git a/book/Logo.svg → doc/Logo.svg b/book/Logo.svg → doc/Logo.svg
diff --git a/doc/Makefile b/doc/Makefile
diff --git a/book/_config.yml → doc/_config.yml b/book/_config.yml → doc/_config.yml
@@ -5,10 +5,10 @@
 
 #######################################################################################
 # Book settings
-title                       : Probabilistic Modelling  # The title of the book. Will be placed in the left navbar.
-author                      : Tom Schierenbeck  # The author of the book
+title                       : Probabilistic Modelling  # The title of the doc. Will be placed in the left navbar.
+author                      : Tom Schierenbeck  # The author of the doc
 copyright                   : "2024"  # Copyright year to be placed in the footer
-logo                        : "Logo.svg"  # A path to the book logo
+logo                        : "Logo.svg"  # A path to the doc logo
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
@@ -18,16 +18,16 @@ execute:
 # Define the name of the latex output file for PDF builds
 latex:
   latex_documents:
-    targetname: book.tex
+    targetname: doc.tex
 
 # Add a bibtex file so that we can create citations
 bibtex_bibfiles:
   - references.bib
 
-# Information about where the book exists on the web
+# Information about where the doc exists on the web
 repository:
-  url: https://github.com/tomsch420/probabilistic_model  # Online location of your book
-  path_to_book: docs  # Optional path to your book, relative to the repository root
+  url: https://github.com/tomsch420/probabilistic_model  # Online location of your doc
+  path_to_book: docs  # Optional path to your doc, relative to the repository root
   branch: master  # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your doc

diff --git a/doc/_static/style.css b/doc/_static/style.css
diff --git a/book/_toc.yml → doc/_toc.yml b/book/_toc.yml → doc/_toc.yml
@@ -1,7 +1,7 @@
 # Table of contents
 # Learn more at https://jupyterbook.org/customize/toc.html
 
-format: jb-book
+format: jb-doc
 root: intro
 chapters:
 - file: probability_theory

diff --git a/book/circuits.md → doc/circuits.md b/book/circuits.md → doc/circuits.md