#1 Work in progress:

-Build html doc
-Host documentation

[ci skip]

.gitignore

@@ -4,6 +4,9 @@ tests/dev_tests/*
 *.private
 *.unused
 
+# Documentation
+doc/_*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

doc/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)

doc/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'ezGPX'
+copyright = '2023, Fabien ALLEMAND'
+author = 'Fabien ALLEMAND'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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']

doc/ezgpx.gpx.rst

@@ -0,0 +1,21 @@
+ezgpx.gpx package
+=================
+
+Submodules
+----------
+
+ezgpx.gpx.gpx module
+--------------------
+
+.. automodule:: ezgpx.gpx.gpx
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.gpx
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/ezgpx.gpx_elements.rst

@@ -0,0 +1,125 @@
+ezgpx.gpx\_elements package
+===========================
+
+Submodules
+----------
+
+ezgpx.gpx\_elements.bounds module
+---------------------------------
+
+.. automodule:: ezgpx.gpx_elements.bounds
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.copyright module
+------------------------------------
+
+.. automodule:: ezgpx.gpx_elements.copyright
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.email module
+--------------------------------
+
+.. automodule:: ezgpx.gpx_elements.email
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.extensions module
+-------------------------------------
+
+.. automodule:: ezgpx.gpx_elements.extensions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.gpx module
+------------------------------
+
+.. automodule:: ezgpx.gpx_elements.gpx
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.link module
+-------------------------------
+
+.. automodule:: ezgpx.gpx_elements.link
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.metadata module
+-----------------------------------
+
+.. automodule:: ezgpx.gpx_elements.metadata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.person module
+---------------------------------
+
+.. automodule:: ezgpx.gpx_elements.person
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.point module
+--------------------------------
+
+.. automodule:: ezgpx.gpx_elements.point
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.point\_segment module
+-----------------------------------------
+
+.. automodule:: ezgpx.gpx_elements.point_segment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.route module
+--------------------------------
+
+.. automodule:: ezgpx.gpx_elements.route
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.track module
+--------------------------------
+
+.. automodule:: ezgpx.gpx_elements.track
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.track\_segment module
+-----------------------------------------
+
+.. automodule:: ezgpx.gpx_elements.track_segment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.gpx\_elements.way\_point module
+-------------------------------------
+
+.. automodule:: ezgpx.gpx_elements.way_point
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.gpx_elements
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/ezgpx.gpx_parser.rst

@@ -0,0 +1,21 @@
+ezgpx.gpx\_parser package
+=========================
+
+Submodules
+----------
+
+ezgpx.gpx\_parser.parser module
+-------------------------------
+
+.. automodule:: ezgpx.gpx_parser.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.gpx_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/ezgpx.gpx_writer.rst

@@ -0,0 +1,21 @@
+ezgpx.gpx\_writer package
+=========================
+
+Submodules
+----------
+
+ezgpx.gpx\_writer.writer module
+-------------------------------
+
+.. automodule:: ezgpx.gpx_writer.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.gpx_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/ezgpx.rst

@@ -0,0 +1,22 @@
+ezgpx package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ezgpx.gpx
+   ezgpx.gpx_elements
+   ezgpx.gpx_parser
+   ezgpx.gpx_writer
+   ezgpx.utils
+
+Module contents
+---------------
+
+.. automodule:: ezgpx
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/ezgpx.utils.rst

@@ -0,0 +1,37 @@
+ezgpx.utils package
+===================
+
+Submodules
+----------
+
+ezgpx.utils.algorithms module
+-----------------------------
+
+.. automodule:: ezgpx.utils.algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.utils.distance module
+---------------------------
+
+.. automodule:: ezgpx.utils.distance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.utils.projections module
+------------------------------
+
+.. automodule:: ezgpx.utils.projections
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/index.rst

@@ -0,0 +1,21 @@
+.. ezGPX documentation master file, created by
+   sphinx-quickstart on Tue Jul 18 14:35:47 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ezGPX's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd