Merge pull request #166 from sroberts88962/fix/update-docs-navigation

Fix/update docs navigation

.github/workflows/release-please.yml

@@ -141,7 +141,7 @@ jobs:
   upload_to_pypi:
     needs: ["release-please", "make_sdist", "conda-deploy"]
     runs-on: ubuntu-latest
-    #if: ${{ needs.release-please.outputs.release_created }}
+    if: ${{ needs.release-please.outputs.release_created }}
     steps:
       - uses: actions/download-artifact@v3
         with:

CHANGELOG.md

@@ -1,5 +1,71 @@
 # Changelog
 
+## [1.5.11](https://github.com/Loop3D/LoopStructural/compare/v1.5.10...v1.5.11) (2023-12-03)
+
+
+### Bug Fixes
+
+* :art: moving get interpolator out of geologicalmodel ([3f52950](https://github.com/Loop3D/LoopStructural/commit/3f5295050bff2cbd0ecb769e703678550abcc632))
+* :bug: add default solver to discrete interpolator ([3b93f7f](https://github.com/Loop3D/LoopStructural/commit/3b93f7f594ba519368ebde8d3ed6e3a83979ce14))
+* :bug: evalute changed to evaluate ([4e93caf](https://github.com/Loop3D/LoopStructural/commit/4e93caf37f6c917f530bb0d26ffafdbff1279cb3))
+* :bug: return a as array not transpose ([46e9edf](https://github.com/Loop3D/LoopStructural/commit/46e9edfa69442747bcdcd83af283a7584a8bfbf8))
+* :sparkles: adding interpolator factory ([245517b](https://github.com/Loop3D/LoopStructural/commit/245517bdf3cfd2d0dce2f5b6961d54193e5f7a1b))
+* :sparkles: adding support factory ([c3ec7a8](https://github.com/Loop3D/LoopStructural/commit/c3ec7a85dadb4e19bb65be6fd8d21852f54ce16c))
+* :sparkles: adding support type enum ([82c0bd5](https://github.com/Loop3D/LoopStructural/commit/82c0bd59a16f7ccc0843141dc90fd14def19c1f4))
+* :sparkles: bounding box object ([75941f0](https://github.com/Loop3D/LoopStructural/commit/75941f02d6cdfeaf29306ff6d55428cb77933dde))
+* :sparkles: new api for accessing interpolation for a single scalar field ([5bca235](https://github.com/Loop3D/LoopStructural/commit/5bca2350e88f8e0f857e1b30da823de4a490f974))
+* :sparkles: transformation object ([48e6c32](https://github.com/Loop3D/LoopStructural/commit/48e6c32b0149227b6c9efa80cf3a5cd6ef6c7b05))
+* add logger to surface ([8fcf89c](https://github.com/Loop3D/LoopStructural/commit/8fcf89c79a51d26382ff160cbb43dd4c95b9cf27))
+* adding a factory method to create an interpolator ([8aba4bd](https://github.com/Loop3D/LoopStructural/commit/8aba4bdfdecd1ef5dfd976c9c8145d7a171f6c3a))
+* adding api module ([7ab7c07](https://github.com/Loop3D/LoopStructural/commit/7ab7c077ea983a8569613ab1fc50555bd4276421))
+* adding datatypes module ([2102c72](https://github.com/Loop3D/LoopStructural/commit/2102c72c3f8a83aec416ad6c241728b16ac95fa6))
+* adding example execution time to git ignore ([7ac99d3](https://github.com/Loop3D/LoopStructural/commit/7ac99d378b236f2fa4a48295cb0108852b9c7029))
+* adding exception if nsteps=0 or <0 ([0940c55](https://github.com/Loop3D/LoopStructural/commit/0940c552b5c1ba931c8d6cfe02702c2e07d8020e))
+* adding fixture for bb and interpolatortype ([2a3e84e](https://github.com/Loop3D/LoopStructural/commit/2a3e84ee88b12cccf2e28a8bd7ed7e9a585bba3a))
+* adding isovalue to surfaces created by isosurfacer ([754541f](https://github.com/Loop3D/LoopStructural/commit/754541fc4010bc3632a101e4ca4f895325baa49b))
+* adding mesa ([7f0fb94](https://github.com/Loop3D/LoopStructural/commit/7f0fb9476348fdf7dcf8402420793737a3da2dd5))
+* adding nsteps to bb ([82e4dac](https://github.com/Loop3D/LoopStructural/commit/82e4dac7685882323ed65bfb47cb8fa4b4d7f69b))
+* adding placeholder for interpolate api ([f9709b5](https://github.com/Loop3D/LoopStructural/commit/f9709b54515b97cee9eed429110cbb5101edd24c))
+* adding surface data type for storing triangular surfaces ([0d383cf](https://github.com/Loop3D/LoopStructural/commit/0d383cf5d472852b5d2690b71efa9682b0b84fe4))
+* adding surfacer ([47c390d](https://github.com/Loop3D/LoopStructural/commit/47c390d0abcb4fc825e48c1c344f6309212ed785))
+* adding test to bb ([485f084](https://github.com/Loop3D/LoopStructural/commit/485f08485a0d602fc7479378faaf92ad698da255))
+* bug with size of constraints array ([66a9825](https://github.com/Loop3D/LoopStructural/commit/66a982554358b6a629aa8d7c2a68469626bd30da))
+* change to interpolation factory ([91bcbed](https://github.com/Loop3D/LoopStructural/commit/91bcbed956d2ca80f59c03c730ea53ba50c1436b))
+* Check for empty features and escape early ([083a195](https://github.com/Loop3D/LoopStructural/commit/083a195004f45cc52086b503441f93f97cb3f21d))
+* create folded fold frame using updated code ([7e1db31](https://github.com/Loop3D/LoopStructural/commit/7e1db31ed275099cd830b695dd416ff7aa7cf994))
+* Ensure modifications to data frame are on a copy of that frame ([ed61243](https://github.com/Loop3D/LoopStructural/commit/ed6124380bc95ba91f55c88916c40e2a29463747))
+* fixing lavavu version ([57f649b](https://github.com/Loop3D/LoopStructural/commit/57f649b252b9f2ca37dca42d82f97724a26be271))
+* fixing python 3.10 for docs ([6ea4d84](https://github.com/Loop3D/LoopStructural/commit/6ea4d847de2b737d9ac9279fc5861aa848bfb0e5))
+* flake8 ([9ef0081](https://github.com/Loop3D/LoopStructural/commit/9ef00811979f41eac624508eb436112d3060f43c))
+* flake8 error ([a37fec2](https://github.com/Loop3D/LoopStructural/commit/a37fec28c1946fbd99bfe71eb8dd01dc0cc1966b))
+* formatting ([8175437](https://github.com/Loop3D/LoopStructural/commit/817543773f649c5a03143029fcb6f81acf1fe56e))
+* init file for datatypes ([7f1f62a](https://github.com/Loop3D/LoopStructural/commit/7f1f62ab5e6cd62077cbf594a45cee724feb7716))
+* isinside and init with list ([0ff6735](https://github.com/Loop3D/LoopStructural/commit/0ff6735025ca6eaefc8494861a4b32f5f6af7463))
+* manually incrementing version ([4229d6a](https://github.com/Loop3D/LoopStructural/commit/4229d6a95691e66b0b0fe63df3eb469140b22189))
+* move create interpolator to feature builders ([1c01bdd](https://github.com/Loop3D/LoopStructural/commit/1c01bdde350e23e4018c1a61135d16ed309f766c))
+* moving get interpolator to separate function ([2790d76](https://github.com/Loop3D/LoopStructural/commit/2790d761ec27f00be9a6beee7305a0827f4617b3))
+* osmesa ([54595cb](https://github.com/Loop3D/LoopStructural/commit/54595cb5ebcc80de9bd09bb8bdd694685feb1e39))
+* pypi only on release ([619557b](https://github.com/Loop3D/LoopStructural/commit/619557b3ff76c9dd5996fc6f8136de82369ca248))
+* relocating bounding box ([8b18eb2](https://github.com/Loop3D/LoopStructural/commit/8b18eb20fbdea8f84bd87e9832c7f63cc2761613))
+* removing calculate pairs from dsi ([e35003c](https://github.com/Loop3D/LoopStructural/commit/e35003cab2ca27fdc504557696f8e43cd3b9e2ed))
+* removing print property values from lavavu ([306793c](https://github.com/Loop3D/LoopStructural/commit/306793ca4a997752a1e479f9c7ea50ac99695189))
+* removing wavelength variable from refolded fold ([64278b7](https://github.com/Loop3D/LoopStructural/commit/64278b788bb74cad0e2dbf804f097e573a473f9d))
+* return surface object from isosurfacer ([6f28d67](https://github.com/Loop3D/LoopStructural/commit/6f28d67cf11d3e6c14068ee0a6d7426ad9efb944))
+* set min number of elements to 3 ([7a7e9ba](https://github.com/Loop3D/LoopStructural/commit/7a7e9ba62825cc03f5db176d009258c42e097c39))
+* specify argument names for get_interpolator ([e203b4d](https://github.com/Loop3D/LoopStructural/commit/e203b4d5cfacbd6786b4aeda42ed44f45d10a664))
+* trying lavavu without osmesa ([f41b7e7](https://github.com/Loop3D/LoopStructural/commit/f41b7e7caddcbc5936b898e1fe426d3fcbf8b1bd))
+* trying to use tini for x ([4b38221](https://github.com/Loop3D/LoopStructural/commit/4b38221a6a09c4c4d9746dac379d3e9f23c1260c))
+* updating dockerfile for documentaiton build ([1bd6d38](https://github.com/Loop3D/LoopStructural/commit/1bd6d387443280bb43de46a6c2e6bcde3c8785b7))
+* updating docs to use LS version ([f8aac3a](https://github.com/Loop3D/LoopStructural/commit/f8aac3ab577b89f3b29de104df1a7c76840575cc))
+* updating examples to not use pyamg ([66239cb](https://github.com/Loop3D/LoopStructural/commit/66239cb480d88c7f4d3a6530e841ae3524a65a8a))
+* updating lavavu to use new bounding box ([96306db](https://github.com/Loop3D/LoopStructural/commit/96306db7ef7c41017183f67046ce32ac4f3ab5bb))
+* updating product to prod ([5d050ca](https://github.com/Loop3D/LoopStructural/commit/5d050cab8c63591bf41291fe6c973a37d3849bee))
+* updating so change work for building model ([08adb56](https://github.com/Loop3D/LoopStructural/commit/08adb5624e9d42a889c1def8fb1c0e126c75cffd))
+* updating to new bbox ([fb450e0](https://github.com/Loop3D/LoopStructural/commit/fb450e02ef52b4959cf4e8e94af157bc9516a93a))
+* Use fault names if present before labelling fault Fault_XXX ([7bf34fc](https://github.com/Loop3D/LoopStructural/commit/7bf34fc3e841e243b1a34dbaf36294b5ce17306f))
+* use property array rather than store properties on grid ([2d95b85](https://github.com/Loop3D/LoopStructural/commit/2d95b852eb0f327daddbf6a786f354853c645242))
+* value changed to point ([4144c59](https://github.com/Loop3D/LoopStructural/commit/4144c59d134b420875bb4247a361e26be1547c9c))
+
 ## [1.5.10](https://github.com/Loop3D/LoopStructural/compare/v1.5.9...v1.5.10) (2023-03-14)
 
 

docs/Dockerfile

@@ -32,10 +32,10 @@ RUN conda install -c conda-forge\
     python=3.10\
     -y
 RUN pip install git+https://github.com/geopandas/geopandas.git@v0.10.2
-RUN pip install lavavu-osmesa==1.8.45
+RUN pip install lavavu-osmesa==1.8.45 
 ENV LD_LIBRARY_PATH=/opt/conda/lib/python3.10/site-packages/lavavu_osmesa.libs
 RUN conda install -c conda-forge pydata-sphinx-theme 
-
+RUN pip install sphinxcontrib-bibtex
 ENV TINI_VERSION v0.19.0
 ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
 RUN chmod +x /tini

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinx==3.5.4
 sphinx_gallery
 sphinxcontrib-bibtex
-sphinx_rtd_theme
+pydata_sphinx_theme
 myst-parser

docs/source/API.rst

@@ -1,6 +1,7 @@
 API
 ---
 
+
 .. autosummary::
    :caption: API
    :toctree: _autosummary
@@ -12,4 +13,4 @@ API
    LoopStructural.interpolators
    LoopStructural.api
    LoopStructural.visualisation
-   LoopStructural.datatypes
+   LoopStructural.datatypes

docs/source/conf.py

@@ -26,6 +26,10 @@
 # The full version, including alpha/beta/rc tags
 release = LoopStructural.__version__
 
+# -- Internationalization ----------------------------------------------------
+
+# specifying the natural language populates some key tags
+language = "en"
 
 # -- General configuration ---------------------------------------------------
 autoclass_content = "both"  # include both class docstring and __init__
@@ -54,7 +58,10 @@
     "sphinx_gallery.gen_gallery",
     # citations
     "myst_parser",
+    "sphinxcontrib.bibtex",
 ]
+bibtex_bibfiles = ["docs_references.bib"]
+bibtex_default_style = "plain"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -66,35 +73,53 @@
 
 html_theme_options = {
     "icon_links": [
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/loop3d",
+            "icon": "fab fa-twitter",
+        },
         {
             "name": "GitHub",
             "url": "https://github.com/loop3d/LoopStructural",
-            "icon": "fab fa-github-square",
+            "icon": "fab fa-github",
         },
         {
-            "name": "Twitter",
-            "url": "https://twitter.com/loop3d",
-            "icon": "fab fa-twitter-square",
+            "name": "PyPI",
+            "url": "https://pypi.org/project/LoopStructural",
+            "icon": "fa-custom fa-pypi",
         },
     ],
+
     #     "navbar_start": ["navbar-logo", "navbar-version"],
     #     "use_edit_page_button": True,
     "collapse_navigation": True,
     "external_links": [
         {"name": "Loop3d", "url": "https://www.loop3d.org"},
     ],
+    "header_links_before_dropdown": 4,
+    "logo": {
+        "text": "LoopStructural - {}".format(release),
+        "image_light": "_static/infinity_loop_icon.svg",
+        "image_dark": "_static/infinity_loop_icon.svg",
+    },
 }
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 html_theme = "pydata_sphinx_theme"
+html_sourcelink_suffix = ""
+html_last_updated_fmt = ""  # to reveal the build date in the pages meta
 
 # 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"]
+html_css_files = ["custom.css"]
+html_js_files = ["custom-icon.js"]
+todo_include_todos = True
+
 autosummary_mock_imports = [
     "LoopStructural.interpolators._cython",
 ]