Welcome to the documentation for logbookgenerator!
=================================================================

.. image:: https://img.shields.io/github/v/tag/unkokaeru/logbookgenerator?label=version
    :target: https://github.com/unkokaeru/logbookgenerator
    :alt: GitHub tag (latest by date)
.. image:: https://tokei.rs/b1/github/unkokaeru/logbookgenerator?category=code
    :target: https://github.com/unkokaeru/logbookgenerator
    :alt: Lines Of Code
.. image:: https://img.shields.io/github/actions/workflow/status/unkokaeru/logbookgenerator/continuous_integration.yml?label=tests
    :target: https://github.com/unkokaeru/logbookgenerator/actions/workflows/continuous_integration.yml
    :alt: Continuous Integration (CI) Tests
.. image:: https://img.shields.io/github/last-commit/unkokaeru/logbookgenerator
    :target: https://github.com/unkokaeru/logbookgenerator/actions/workflows/continuous_integration.yml
    :alt: GitHub last commit

Generates a logbook. Designed for the University of Lincoln's Scientific Computing module.

-  `Features <#features>`__
-  `Installation <#installation>`__
-  `Usage <#usage>`__
-  `Documentation <#documentation>`__
-  `Contributing <#contributing>`__
-  `License <#license>`__

Features
--------

-  ☒ Installable via pip
-  ☒ Command-line interface
-  ☒ Interactive documentation
-  ☐ Dynamically generate logbooks

Installation
------------

To install logbookgenerator, simply run:

.. code-block:: bash

    pip install logbookgenerator

Usage
-----

After installation, you can use logbookgenerator by
running:

.. code:: bash

    $ python3 -m logbookgenerator
    # or
    $ logbookgenerator

Documentation
-------------

For more information, you can find the documentation within the
`docs <./docs/index.html>`__ directory or on the project's [GitHub
Pages](https://unkokaeru.github.io/logbookgenerator/).

Contributing
------------

Contributions are welcome! Please refer to our
`CONTRIBUTING.md <./CONTRIBUTING.md>`__ for more information.

License
-------

This project is licensed under the MIT License - see the
`LICENSE <./LICENSE>`__ file for details.

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`