Added Sphinx Documentation

.github/workflows/sphinx.yml

@@ -0,0 +1,57 @@
+name: Sphinx build
+
+on:
+  # Push/Pull for main branch.
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # Run workflow manually from actions tab.
+  workflow_dispatch:
+
+jobs:
+  build:
+    # Specify an OS for the runner
+    runs-on: ubuntu-latest
+
+    #Define steps
+    steps:
+
+      # Firstly, checkout repo
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      # Set up Python env
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      # Install dependencies
+      - name: Install Python dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install poetry
+          poetry install
+
+      - name: Build documentation
+        run: |
+          mkdir gh-pages
+          touch gh-pages/.nojekyll
+          pushd docs/source/
+          poetry run sphinx-build -b html . _build
+          popd
+          cp -r docs/source/_build/* gh-pages/
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: gh-pages
+      # Deploys to the gh-pages branch if the commit was made to main, the 
+      # gh-pages then takes over serving the html
+      - name: Deploy documentation
+        if: ${{ github.event_name == 'push' }}
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: gh-pages

.gitignore

@@ -1,4 +1,5 @@
 jsons/
 settings.json
 local/
-localcache/
+localcache/
+*pyc

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     = source
+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)

build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 71cb8f0d0809ce17a42e72d886f9cb20
+tags: 645f666f9bcd5a90fca523b33c5a78b7

build/html/_sources/core/cli.rst.txt

@@ -0,0 +1,3 @@
+======================
+Command Line Interface
+======================

build/html/_sources/core/doc.rst.txt

@@ -0,0 +1,46 @@
+=============
+Documentation
+=============
+
+Flight Update
+=============
+.. automodule:: flight_update
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Elastic Search Flight Client
+============================
+
+.. automodule:: flight_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Flight Client Wrapper
+=====================
+
+.. automodule:: simple_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Write Flights
+=============
+
+.. automodule:: write_flights
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Get Moles
+=========
+.. automodule:: moles
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

build/html/_sources/index-sphinx-test.rst.txt

@@ -0,0 +1,49 @@
+.. Flight-pipeline documentation master file, created by
+   sphinx-quickstart on Wed Mar  5 15:23:55 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Flight-pipeline documentation
+=============================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+.. image:: _images/Flight-finder-preview.png
+   :align: center
+   :alt: Alternative text for the image
+   :width: 50%
+
+
+.. automodule:: flight_update
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: flight_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: simple_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: write_flights
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: moles
+   :members:
+   :undoc-members:
+   :show-inheritance:
+