Stable release

To install droidoc, run this command in your terminal:

$ 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.

From sources

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

You can either clone the public repository:

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

Or download the tarball:

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

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

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

Development

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

To get more information about the preconfigured tasks:

$ make help

Usage

To use droidoc in a project:

import droidoc

With the docker:

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

Run tests

$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. You can also take a look at the contributing guide

📝 License

This project is MIT licensed.