Merge pull request #160 from Kyran-Cook/updated_Docs

Updated docs

Author: Kyran-Cook

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, 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: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

@@ -0,0 +1,32 @@
+a {
+    color: #00718e;
+}
+
+a .sidebar-navigation{
+    color: #00718e;
+}
+
+.sidebar-tree a {
+    color: #00718e !important; /* Sidebar links */
+}
+
+.sidebar-tree svg {
+    color: #00718e !important; /* Normal arrow color */
+}
+
+/* Hide the TOC caption heading on the index page */
+.toctree-wrapper > p.caption {
+    display: none;
+}
+
+/* Style the custom TOC expander arrows */
+.toctree-expander {
+    color: #00718e; /* Your preferred color */
+}
+
+/* Optional: Hover effect */
+.toctree-expander:hover {
+    color: #005f73;
+}
+
+

docs/_static/custom.js

@@ -0,0 +1,29 @@
+document.addEventListener("DOMContentLoaded", function () {
+    document.querySelectorAll(".collapsible-toc li").forEach(function (item) {
+        const sublist = item.querySelector("ul");
+        const link = item.querySelector("a");
+        if (sublist && link) {
+            const toggle = document.createElement("span");
+            toggle.innerHTML = `
+                <svg class="toctree-expander" viewBox="0 0 24 24" width="16" height="16" stroke="currentColor" fill="none" stroke-width="2">
+                    <polyline points="6 9 12 15 18 9"></polyline>
+                </svg>
+            `;
+            toggle.style.cursor = "pointer";
+            toggle.style.marginLeft = "8px";
+
+            toggle.addEventListener("click", function () {
+                if (sublist.style.display === "none") {
+                    sublist.style.display = "block";
+                    toggle.querySelector("polyline").setAttribute("points", "6 15 12 9 18 15");
+                } else {
+                    sublist.style.display = "none";
+                    toggle.querySelector("polyline").setAttribute("points", "6 9 12 15 18 9");
+                }
+            });
+
+            sublist.style.display = "none";
+            link.insertAdjacentElement("afterend", toggle);
+        }
+    });
+});

docs/_static/geodepy-logo-dark.png

@@ -0,0 +1,6 @@
+<div class="sidebar-extra" style="text-align:left; margin-top:0px; margin-bottom:5px ;">
+    <p style="font-size:14px; margin-bottom:10px;">GeodePy is a package of tools for manipulating goespatial datasets using Python.</p>
+    <a href="https://github.com/GeoscienceAustralia/GeodePy" target="_blank">
+    <img src="https://img.shields.io/badge/GitHub-GeodePy-blue?logo=github" alt="GitHub Badge" />
+    </a>
+</div>

docs/_static/geodepy-logo-light.png

@@ -0,0 +1,12 @@
+Authors
+=======
+
+GeodePy is developed and maintained by the Geoscience Australia National Geodesy Team. Over time, many contributors have helped improve the package.
+
+* **Craig Harrison** - Project Management - `harry093 <https://github.com/harry093>`_
+* **Josh Batchelor** - Initial Work, Geodesy and Surveying - `BatchelorJ <https://github.com/BatchelorJ>`_
+* **Jonathan Mettes** - Testing, Integration and Development - `jmettes <https://github.com/jmettes>`_
+* **Jack McCubbine** - Height Module - `JackMcCubbineGA <https://github.com/JackMcCubbineGA>`_
+* **Kyran Cook** - Documentation and Uplift - `KyranCookGA <https://github.com/KyranCookGA>`_
+
+See also the list of `contributors <https://github.com/GeoscienceAustralia/geodepy/graphs/contributors>`_ who have participated in this project.

docs/_static/geodepy-logo.png

@@ -0,0 +1,11 @@
+Contributing
+==================
+
+We welcome contributions from the community to help improve GeodePy! Whether you're fixing bugs, adding new features, or enhancing documentation, your input is valuable. Open source projects live and die based on the support they recieve.
+
+This document outlines some of the guidlines and advice for contributing to GeodePy.
+
+Code of Conduct
+----------------
+
+By participating in this project, you agree to abide by the `Python Software Foundation Code of Conduct <https://policies.python.org/python.org/code-of-conduct/>`_. Please read it to understand the expectations for behavior when contributing to this project.