GEOPY-1930: move 3rd-party license file under doc

README.rst

@@ -37,7 +37,7 @@
 surface-apps
 ============
 
-Surface detection within geoscientific data.
+The **surface-apps** library offers tools for the creation and manipulation of surface objects using various Python libraries and `geoh5py <https://mirageoscience-geoh5py.readthedocs-hosted.com/>`_.
 
 .. contents:: Table of Contents
    :local:
@@ -65,7 +65,7 @@ Within a conda environment
 --------------------------
 
 You can install (or update) a conda environment with all the requires packages to run **surface-apps**.
-To do so you can directly run the **Install_or_Update.bat** file by double left clicking on it.
+To do so you can directly run the **install.bat** file by double left clicking on it.
 
 Install with conda
 ------------------
@@ -156,7 +156,7 @@ The use of Third Party Software is governed by the terms of such software licens
 Third Party Software notices and/or additional terms and conditions are located in the
 `THIRD_PARTY_SOFTWARE.rst`_ file.
 
-.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
+.. _THIRD_PARTY_SOFTWARE.rst: ./docs/source/THIRD_PARTY_SOFTWARE.rst
 
 Copyright
 ^^^^^^^^^

THIRD_PARTY_SOFTWARE.rst → docs/source/THIRD_PARTY_SOFTWARE.rst

@@ -1,4 +1,7 @@
-The my-app repository and source distributions bundle several libraries that are
+Third Party Software
+====================
+
+The surface-apps repository and source distributions bundle several libraries that are
 compatibly licensed.  We list these here.
 
 .. list-table::
@@ -26,6 +29,6 @@ compatibly licensed.  We list these here.
    * - `tqdm <https://github.com/tqdm>`_
      - MPL-2.0 or MIT
      - A Fast, Extensible Progress Bar for Python and CLI
-   * - `scikit-image <https://github.com/scikit-image/scikit-image >`_
+   * - `scikit-image <https://github.com/scikit-image/scikit-image>`_
      - BSD-3-Clause
      - Image processing in Python

docs/source/conf.py

@@ -7,25 +7,30 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 import sys
-from datetime import datetime
 from pathlib import Path
+
+from datetime import datetime
 from importlib.metadata import version
+
 from packaging.version import Version
 
+
 sys.path.insert(0, Path("../..").resolve())
 
 project = "surface-apps"
 author = "Mira Geoscience Ltd."
 project_copyright = "%Y, Mira Geoscience Ltd"
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+copyright = "Mira Geoscience Ltd"
 
 # The full version, including alpha/beta/rc tags.
 release = version("surface-apps")
 # The shorter X.Y.Z version.
 version = Version(release).base_version
 
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
 autodoc_mock_imports = [
     "numpy",
     "geoh5py",
@@ -43,16 +48,17 @@
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
 html_theme = "alabaster"
 html_theme_options = {
-    'description': f"version {release}",
+    "description": f"version {release}",
 }
-html_static_path = ["_static"]
+html_static_path = []
+
 
 def get_copyright_notice():
     return f"Copyright {datetime.now().strftime(project_copyright)}"
 
+
 rst_epilog = f"""
 .. |copyright_notice| replace:: {get_copyright_notice()}.
 """

docs/source/index.rst

@@ -25,6 +25,7 @@ Content
    usage
    iso_surfaces
    api_reference
+   THIRD_PARTY_SOFTWARE
 
 
 License
@@ -42,16 +43,6 @@ GNU Lesser General Public License for more details.
 A copy of the GNU Lesser General Public License can be accessed from <https://www.gnu.org/licenses/>.
 
 
-Third Party Software
-^^^^^^^^^^^^^^^^^^^^
-The surface-apps Software may provide links to third party libraries or code (collectively “Third Party Software”)
-to implement various functions. Third Party Software does not comprise part of the Software.
-The use of Third Party Software is governed by the terms of such software license(s).
-Third Party Software notices and/or additional terms and conditions are located in the
-`THIRD_PARTY_SOFTWARE`_ file.
-
-.. _THIRD_PARTY_SOFTWARE: THIRD_PARTY_SOFTWARE.rst
-
 Copyright
 ^^^^^^^^^
 |copyright_notice|

package.rst

@@ -0,0 +1,59 @@
+Surface-apps
+============
+
+The **surface-apps** library offers tools for the creation and manipulation of surface objects using various Python libraries and `geoh5py <https://mirageoscience-geoh5py.readthedocs-hosted.com/>`_.
+
+Installation
+^^^^^^^^^^^^
+**Surface-apps** is currently written for Python 3.10 or higher.
+
+Install **surface-apps** from PyPI::
+
+    $ pip install surface-apps
+
+
+Feedback
+^^^^^^^^
+Have comments or suggestions? Submit feedback through `Mira Geoscience Support portal <https://www.mirageoscience.com/technical-support>`_.
+
+Visit `Mira Geoscience website <https://mirageoscience.com/>`_ to learn more about our products
+and services.
+
+
+License
+^^^^^^^
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+Third Party Software
+^^^^^^^^^^^^^^^^^^^^
+The surface-apps Software may provide links to third party libraries or code (collectively “Third Party Software”)
+to implement various functions. Third Party Software does not comprise part of the Software.
+The use of Third Party Software is governed by the terms of such software license(s).
+Third Party Software notices and/or additional terms and conditions are located in the
+`THIRD_PARTY_SOFTWARE.rst`_ file.
+
+.. _THIRD_PARTY_SOFTWARE.rst: docs/source/THIRD_PARTY_SOFTWARE.rst
+
+
+Copyright
+^^^^^^^^^
+Copyright (c) 2022-2025 Mira Geoscience Ltd.