Merge pull request #161 from GeoscienceAustralia/updated_docs

Updated docs

Author: harry093

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# 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"
+
+  apt_packages:
+    - libgdal-dev
+    - gdal-bin
+
+# 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

README.md

@@ -1,14 +1,33 @@
 # ![GeodePy](https://github.com/GeoscienceAustralia/GeodePy/blob/master/docs/geodepy-logo.png)
 
-[![Travis](https://img.shields.io/travis/GeoscienceAustralia/GeodePy/master.svg?label=Travis%20CI)](https://travis-ci.org/GeoscienceAustralia/GeodePy) [![Coverage Status](https://coveralls.io/repos/github/GeoscienceAustralia/GeodePy/badge.svg)](https://coveralls.io/github/GeoscienceAustralia/GeodePy)
+GeodePy is a python package for precise geodetic and survey computations.
 
-This is a package of tools for manipulating geospatial datasets using Python and tested in Python 3.6.4.
+## Documentation
 
-### Tutorials
+See [here](https://geodepy.readthedocs.io/) for documentation around downloading and using GeodePy.
 
-See [here](https://github.com/GeoscienceAustralia/GeodePy/tree/master/docs/tutorials) for worked examples of common GeodePy functions and routines.
+## Features
 
-### Dependencies
+GeodePy includes a variety of features for geodesy and geospatial data manipulation, including:
+
+* Converting between coordinate types
+* Transforming between datums
+* Calculating geodetic distances and bearings
+* Working with geoid models
+* Surveying calculations
+* Various classes for angles, coordinates, and datums
+* Statistics
+* And more!
+
+## Installation
+
+GeodePy is available on PyPi:
+
+```console
+$ pip install geodepy
+```
+
+## Dependencies
 
 This package requires the following PyPI Packages installed:
 
@@ -19,32 +38,21 @@ SciPy
 
 Additionally, the geodepy.height module requires the GDAL library (tested using GDAL 3.0.4). For more information, see [here](https://gdal.org/index.html) for information about GDAL, [here](https://anaconda.org/conda-forge/gdal) for Anaconda support for GDAL and [here](http://www.gisinternals.com/release.php) for GDAL Binaries for Windows.
 
-### Testing
+## Testing
 
 Run: `python -m unittest discover geodepy/tests/ --verbose`
 
-## API
-
-```
-cd api/
-virtualenv env
-source env/bin/activate
-pip install -r requirements.txt
-zappa deploy dev
-```
-
-For subsequent updating run: `zappa update dev`
-
-### Authors
+## Authors
 
 * **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 Deployment* - [jmettes](https://github.com/jmettes)
 * **Jack McCubbine** - *Height Module* - [JackMcCubbineGA](https://github.com/JackMcCubbineGA)
+* **Kyran Cook** - *Documentation and Uplift* - [Kyran-Cook](https://github.com/Kyran-Cook)
 
 See also the list of [contributors](https://github.com/GeoscienceAustralia/geodepy/graphs/contributors) who participated in this project.
 
-### License
+## License
 
 Copyright 2018-2020 Geoscience Australia
 

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/favicon.ico

@@ -0,0 +1,6 @@
+# test
+User-agent: *
+
+Disallow: # Allow everything
+
+Sitemap: https://geodepy.readthedocs.io/sitemap.xml