#1 #3 Work in progress:

- Remove tests tmp folder - Update documentation [ci skip]
FABallemand · Jul 5, 2024 · cb48c95 · cb48c95
1 parent cf0f4f5
commit cb48c95
Show file tree

Hide file tree

Showing 32 changed files with 274 additions and 1,031 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/ezgpx.gpx_parser.rst b/docs/ezgpx.gpx_parser.rst
diff --git a/docs/ezgpx.gpx_writer.rst b/docs/ezgpx.gpx_writer.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,10 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
+set SOURCEDIR=source
+set BUILDDIR=build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -25,6 +23,8 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

diff --git a/docs/ezgpx.gpx.rst → docs/source/api/ezgpx.gpx.rst b/docs/ezgpx.gpx.rst → docs/source/api/ezgpx.gpx.rst
diff --git a/docs/ezgpx.gpx_elements.rst → docs/source/api/ezgpx.gpx_elements.rst b/docs/ezgpx.gpx_elements.rst → docs/source/api/ezgpx.gpx_elements.rst
diff --git a/docs/source/api/ezgpx.parser.fit_parser.rst b/docs/source/api/ezgpx.parser.fit_parser.rst
@@ -0,0 +1,21 @@
+ezgpx.parser.fit\_parser package
+================================
+
+Submodules
+----------
+
+ezgpx.parser.fit\_parser.fit\_parser module
+-------------------------------------------
+
+.. automodule:: ezgpx.parser.fit_parser.fit_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.parser.fit_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.parser.gpx_parser.rst b/docs/source/api/ezgpx.parser.gpx_parser.rst
@@ -0,0 +1,21 @@
+ezgpx.parser.gpx\_parser package
+================================
+
+Submodules
+----------
+
+ezgpx.parser.gpx\_parser.gpx\_parser module
+-------------------------------------------
+
+.. automodule:: ezgpx.parser.gpx_parser.gpx_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.parser.gpx_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.parser.kml_parser.rst b/docs/source/api/ezgpx.parser.kml_parser.rst
@@ -0,0 +1,21 @@
+ezgpx.parser.kml\_parser package
+================================
+
+Submodules
+----------
+
+ezgpx.parser.kml\_parser.kml\_parser module
+-------------------------------------------
+
+.. automodule:: ezgpx.parser.kml_parser.kml_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.parser.kml_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.parser.rst b/docs/source/api/ezgpx.parser.rst
@@ -0,0 +1,32 @@
+ezgpx.parser package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ezgpx.parser.fit_parser
+   ezgpx.parser.gpx_parser
+   ezgpx.parser.kml_parser
+   ezgpx.parser.xml_parser
+
+Submodules
+----------
+
+ezgpx.parser.parser module
+--------------------------
+
+.. automodule:: ezgpx.parser.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.parser.xml_parser.rst b/docs/source/api/ezgpx.parser.xml_parser.rst
@@ -0,0 +1,21 @@
+ezgpx.parser.xml\_parser package
+================================
+
+Submodules
+----------
+
+ezgpx.parser.xml\_parser.xml\_parser module
+-------------------------------------------
+
+.. automodule:: ezgpx.parser.xml_parser.xml_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.parser.xml_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/ezgpx.rst → docs/source/api/ezgpx.rst b/docs/ezgpx.rst → docs/source/api/ezgpx.rst
@@ -7,17 +7,12 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   ezgpx.fit_parser
    ezgpx.gpx
    ezgpx.gpx_elements
-   ezgpx.gpx_parser
-   ezgpx.gpx_writer
-   ezgpx.kml_parser
-   ezgpx.kml_writer
    ezgpx.parser
+   ezgpx.schemas
    ezgpx.utils
    ezgpx.writer
-   ezgpx.xml_parser
 
 Module contents
 ---------------

diff --git a/docs/source/api/ezgpx.schemas.rst b/docs/source/api/ezgpx.schemas.rst
@@ -0,0 +1,10 @@
+ezgpx.schemas package
+=====================
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.schemas
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/ezgpx.utils.rst → docs/source/api/ezgpx.utils.rst b/docs/ezgpx.utils.rst → docs/source/api/ezgpx.utils.rst
@@ -20,14 +20,6 @@ ezgpx.utils.distance module
    :undoc-members:
    :show-inheritance:
 
-ezgpx.utils.projections module
-------------------------------
-
-.. automodule:: ezgpx.utils.projections
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

diff --git a/docs/source/api/ezgpx.writer.gpx_writer.rst b/docs/source/api/ezgpx.writer.gpx_writer.rst
@@ -0,0 +1,29 @@
+ezgpx.writer.gpx\_writer package
+================================
+
+Submodules
+----------
+
+ezgpx.writer.gpx\_writer.gpx\_writer module
+-------------------------------------------
+
+.. automodule:: ezgpx.writer.gpx_writer.gpx_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ezgpx.writer.gpx\_writer.gpx\_writer\_method\_behavior\_creator module
+----------------------------------------------------------------------
+
+.. automodule:: ezgpx.writer.gpx_writer.gpx_writer_method_behavior_creator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.writer.gpx_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.writer.kml_writer.rst b/docs/source/api/ezgpx.writer.kml_writer.rst
@@ -0,0 +1,21 @@
+ezgpx.writer.kml\_writer package
+================================
+
+Submodules
+----------
+
+ezgpx.writer.kml\_writer.kml\_writer module
+-------------------------------------------
+
+.. automodule:: ezgpx.writer.kml_writer.kml_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.writer.kml_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/ezgpx.writer.rst b/docs/source/api/ezgpx.writer.rst
@@ -0,0 +1,30 @@
+ezgpx.writer package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ezgpx.writer.gpx_writer
+   ezgpx.writer.kml_writer
+
+Submodules
+----------
+
+ezgpx.writer.writer module
+--------------------------
+
+.. automodule:: ezgpx.writer.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ezgpx.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -0,0 +1,7 @@
+ezGPX API
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   ezgpx.rst
diff --git a/docs/modules.rst → docs/source/api/modules.rst b/docs/modules.rst → docs/source/api/modules.rst
@@ -1,7 +1,8 @@
-ezgpx
+ezGPX
 =====
 
 .. toctree::
    :maxdepth: 4
 
-   ezgpx.rst
+   ezgpx
+   tests
diff --git a/docs/source/api/tests.rst b/docs/source/api/tests.rst
@@ -0,0 +1,29 @@
+tests package
+=============
+
+Submodules
+----------
+
+tests.test\_GPX module
+----------------------
+
+.. automodule:: tests.test_GPX
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tests.test\_utils module
+------------------------
+
+.. automodule:: tests.test_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests
+   :members:
+   :undoc-members:
+   :show-inheritance: