semvec/pypi-packages huggingface dataset:
dj-docs 0.1
django application for documentation
License: MIT
Keywords: django docs,docs

Basic Configuration
===================

Add ``dj_docs`` to the ``INSTALLED_APPS``
-----------------------------------------

.. code:: python

   INSTALLED_APPS = [
       # ...
       'dj_docs',
   ]

Your ``settings.py`` file should now include ``dj_docs`` in the
``INSTALLED_APPS`` list. This will enable the dj_docs app in your Django
project.

Configuration for ``DOC_STRING_MODULES``
----------------------------------------

The ``DOC_STRING_MODULES`` setting in Django’s ``settings.py`` file
allows you to define documentation strings for your project’s modules,
classes, and functions.

To configure ``DOC_STRING_MODULES``, add the following code to your
``settings.py`` file:

.. code:: python

   DOC_STRING_MODULES = [
     {
         "section": "enter title",
         "modules": [
             {
                 "module_name": "module",
                 "class": "module.class",
                 "function": "module.function",
                 "synopsis": "Description"
             },
         ]
     },
   ]

Replace ``"enter title"`` with the title of the page you want to add,
``"module"`` with the name of the module you want to document,
``"module.class"`` with the name of the class you want to document,
``"module.function"`` with the name of the function you want to
document, and ``"Description"`` with the description of the module,
class, or function.

You can add as many sections and modules as you need to document your
project.

Adding the Documentation URL Path
---------------------------------

To access the documentation for this Django app, you’ll need to add a
URL path to your ``urls.py`` file that includes the ``dj_docs`` app’s
URLs. Follow these steps:

.. code:: python

   from django.urls import include # Import the `include` function from Django's `urls` module

   urlpatterns = [
       # ...
       path('docs/', include('dj_docs.urls')), # add url for documentation url to django application
   ]
pochas-geoutils 0.1.3
A Python package includes geo-utils for PoCHAS project
License: MIT

[![Documentation Status](https://readthedocs.org/projects/pochas-geoutils/badge/?version=latest)](https://pochas-geoutils.readthedocs.io/en/latest/?badge=latest)
[![image](https://img.shields.io/pypi/v/pochas-geoutils)](https://pypi.org/project/pochas-geoutils/)
[![image](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![](https://github.com/behzad89/pochas-geoutils/workflows/deploy_pypi/badge.svg)
#  pochas-geoutils Python Package

📦 This Python package provides spatial data handling tools 🛠️ to facilitate the input of data to machine learning algorithms🤖. All functionalities have been developed to enable user-friendly 👨‍💻 geo-data processing in [**POCHAS project**](https://www.swisstph.ch/fr/projects/project-detail/project/effects-of-airborne-pollen-on-cardiorespiratory-health-and-allergic-symptoms)

🌍 This package is especially useful for working with geospatial data in various applications such as environmental monitoring, transportation, and location-based services.

# Documentation

📚 For more information on how to use this package, check out the [documentation](https://pochas-geoutils.readthedocs.io/en/latest/?badge=latest#).

# Installation

- _GitHUB_:
  `pip install git+https://github.com/SwissTPH/pochas-geoutils.git`
- _pip_:
  `pip install pochas-geoutils`

# Tutorial

🎓 A jupyter notebook and test data are available [here](https://github.com/SwissTPH/pochas-geoutils/tree/Tutorials/Tutorials).

# Dockerfile

The Dockerfile 🐳 to setup the **python container** 🐍 is provided on the **ubuntu:20.04** environment [here](https://github.com/behzad89/pochas-geoutils/tree/main/src).

# Contributions
👷‍♂️ Contributions and feedback are always welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
# License
📝 This package is released under the [MIT](./LICENSE)