.. EduLint documentation master file, created by
   sphinx-quickstart on Sun Jul 17 12:16:02 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. sections of this document were adapted from flake8's documentation, available
.. at https://github.com/PyCQA/flake8/blob/6027577d325b0dd8bf1e465ebd29b71b5f0d005b/docs/source/index.rst


EduLint: a Python linter for novice programmers
================================================

EduLint is a linter that helps novice programmers learn writing good code. EduLint notifies its users of many frequent code quality defects and guides them in improving the code. It wraps popular Python linters `Pylint <https://pylint.pycqa.org/>`_ and `Flake8 <https://flake8.pycqa.org/>`_ and extends them by many new defect detectors.

.. tip::

   Try EduLint `here <https://edulint.com/editor/umime_count_a>`_.

.. TODO: Feature list, good start is in first paragraph of configuration.rst

.. tip::

   Learn how to install and run EduLint :ref:`here <run edulint>`.

----------------------

Do you have any problem or could use a new feature? See `project's GitHub issues <https://github.com/GiraffeReversed/edulint/issues>`_.

----------------------

.. toctree::
   :maxdepth: 2

   user_guides
   running
   faq
   configuration
   checkers
   translations
   explanations
   package_api

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

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