Skip to content

Commit

Permalink
add docformatter to contrib docs (#826)
Browse files Browse the repository at this point in the history
* add docformatter to contrib docs
  • Loading branch information
bw4sz authored Oct 30, 2024
1 parent 9f7eee3 commit 099a1d8
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,17 @@ Checkout the deepforest branch, update the `deepforest/meta.yaml` with the new v
{% set sha256 = "fill new" %}
Documentation
-------------

We are using `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ and `Read the Docs <https://readthedocs.org/>`_ for the documentation.

We use `Docformatter <https://pypi.org/project/docformatter/>`_ for formatting and style checking.

.. code-block:: bash
$ docformatter --in-place --recursive deepforest/
Update Documentation
^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -176,4 +181,4 @@ Start
Note:
Do not commit the build directory after making html.

This version correctly follows reStructuredText (reST) conventions and includes code blocks, inline literals, and proper linking. Let me know if you need further adjustments!
This version correctly follows reStructuredText (reST) conventions and includes code blocks, inline literals, and proper linking. Let me know if you need further adjustments!

0 comments on commit 099a1d8

Please sign in to comment.