Added documentation

- Using sphinx to documente the project
- Autodocumenting Python using numpy-style docstr and sphinx autodoc with napoleon

docs/source/conf.py

@@ -0,0 +1,42 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+import django
+
+sys.path.insert(0, os.path.abspath('../../transport_accessibility'))
+os.environ['DJANGO_SETTINGS_MODULE'] = 'transport_accessibility.settings'
+django.setup()
+
+project = 'Transport Accessibility'
+copyright = '2024, Jan Kiljanski and Johannes Randerath'
+author = 'Jan Kiljanski and Johannes Randerath'
+release = '0.1 Beta 1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+        'sphinx.ext.autodoc',
+        'sphinx.ext.napoleon',
+        'sphinx.ext.autosummary',
+        ]
+
+templates_path = ['_templates']
+exclude_patterns = ['**/migrations/*', 'manage.py', 'settings.py', 'admin.py', ]
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+autosummary_generate = True

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. Transport Accessibility documentation master file, created by
+   sphinx-quickstart on Mon Jun  3 13:49:21 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Transport Accessibility's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/manage.rst

@@ -0,0 +1,7 @@
+manage module
+=============
+
+.. automodule:: manage
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules.rst

@@ -0,0 +1,9 @@
+transport_accessibility
+=======================
+
+.. toctree::
+   :maxdepth: 4
+
+   manage
+   pt_map
+   transport_accessibility

docs/source/pt_map.rst

@@ -0,0 +1,84 @@
+pt\_map package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+
+Submodules
+----------
+
+pt\_map.admin module
+--------------------
+
+.. automodule:: pt_map.admin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.apps module
+-------------------
+
+.. automodule:: pt_map.apps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.bridge module
+---------------------
+
+.. automodule:: pt_map.bridge
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.gtfs module
+-------------------
+
+.. automodule:: pt_map.gtfs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.models module
+---------------------
+
+.. automodule:: pt_map.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.tests module
+--------------------
+
+.. automodule:: pt_map.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.urls module
+-------------------
+
+.. automodule:: pt_map.urls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pt\_map.views module
+--------------------
+
+.. automodule:: pt_map.views
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pt_map
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/transport_accessibility.rst

@@ -0,0 +1,45 @@
+transport\_accessibility package
+================================
+
+Submodules
+----------
+
+transport\_accessibility.asgi module
+------------------------------------
+
+.. automodule:: transport_accessibility.asgi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transport\_accessibility.settings module
+----------------------------------------
+
+.. automodule:: transport_accessibility.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transport\_accessibility.urls module
+------------------------------------
+
+.. automodule:: transport_accessibility.urls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transport\_accessibility.wsgi module
+------------------------------------
+
+.. automodule:: transport_accessibility.wsgi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: transport_accessibility
+   :members:
+   :undoc-members:
+   :show-inheritance: