Metadata-Version: 2.4
Name: droidoc
Version: 0.0.1
Summary: Droids Documentation fo Humanoids
License-Expression: MIT
License-File: AUTHORS.rst
License-File: LICENSE
Author: Dinil Bose Palakkatharappil
Author-email: dinilbose@gmail.com
Requires-Python: >=3.12
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Dist: loguru (>=0.7.2,<0.8.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Description-Content-Type: text/x-rst

===============================
droidoc
===============================

.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://gitlab.com/dinilbose/droidoc/-/network/main
.. image:: https://img.shields.io/badge/MIT-green

Droids Documentation fo Humanoids


Stable release
--------------

To install droidoc, run this command in your terminal:

.. code-block:: console

    $ pip install git+https://gitlab.com/dinilbose/droidoc.git

This is the preferred method to install droidoc, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for droidoc can be downloaded from the `Gitlab repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone https://gitlab.com/dinilbose/droidoc.git

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://gitlab.com/dinilbose/droidoc/tarball/main

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ make  # install in the system root
    $ make user # or Install for non-root usage


.. _Gitlab repo: https://gitlab.com/dinilbose/droidoc
.. _tarball: https://gitlab.com/dinilbose/droidoc/tarball/main



Development
-----------

.. code-block:: console

        $ git clone droidoc.git
        $ cd droidoc
        $ make prepare-dev
        $ source .droidoc
        $ make install-dev


To get more information about the preconfigured tasks:

.. code-block:: console

        $ make help

Usage
-----

To use droidoc in a project::

    import droidoc


With the docker:

.. code-block:: console

        $ docker run -u $(id -u):$(id -g) -v $(pwd):/app --rm droidoc_image droidoc




Run tests
---------

.. code-block:: console

        $make tests


Documentation
-------------
The documentation is automatically deployed on https://gitlab.com/dinilbose/droidoc based on main branch

Container
---------
A container is automatically created on https://gitlab.com/dinilbose/droidoc/container_registry


Author
------
👤 **Dinil Bose Palakkatharappil**



🤝 Contributing
---------------
Contributions, issues and feature requests are welcome!

Feel free to check `issues page <https://gitlab.com/dinilbose/droidoc/issues>`_. You can also take a look at the `contributing guide <https://gitlab.com/dinilbose/droidoc/blob/main/CONTRIBUTING.rst>`_


📝 License
----------
This project is `MIT <https://gitlab.com/dinilbose/droidoc/blob/main/LICENSE>`_ licensed.

