Sphinx-updates (#713)

* Fix cohesion bug by adding epsilon1 and epsilon2 (#707)

* Update conda-build-test.yml

mac-os from build runner. Its not available and that's causing errors.

* Update .readthedocs.yml

* update conf.py path from "src/"

---------

Co-authored-by: tiannh7 <[email protected]>

.readthedocs.yml

@@ -9,6 +9,10 @@ version: 2
 sphinx:
   configuration:  docs/development/docs_generator/conf.py
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
 # Build documentation with MkDocs
 #mkdocs:
 #  configuration: mkdocs.yml
@@ -18,6 +22,5 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
-    - requirements: docs/development/docs_generator/requirements.txt
+    - requirements: docs/development/docs_generator/requirements.txt

docs/development/docs_generator/conf.py

@@ -461,7 +461,7 @@
 # add current directory for `generate_api_documentation`
 sys.path.append(os.path.dirname(__name__))
 # add top project directory as well
-sys.path.append(os.path.join(os.path.dirname(__name__),'../../..'))
+sys.path.append(os.path.join(os.path.dirname(__name__),'../../../src/'))
 
 try:
     import underworld

docs/development/docs_generator/generate_api_documentation.py

@@ -16,7 +16,7 @@
 import shutil
 import os
 import glob
-for filename in glob.glob(os.path.join("../../../underworld/function/images/", '*.png')):
+for filename in glob.glob(os.path.join("../../../src/underworld/function/images/", '*.png')):
     shutil.copy(filename, imagedir)
 
 done_mods = set()
@@ -143,4 +143,4 @@ def doc_module(module, modname):
 
 import underworld
 import underworld.visualisation
-doc_module(underworld, 'underworld')
+doc_module(underworld, 'underworld')

docs/development/docs_generator/requirements.txt

@@ -1,2 +1,4 @@
 jupyter
 pandoc
+sphinx_rtd_theme
+mock