Use tabs for application vs package. Add more pyproject.toml and setu…

…p.cfg examples.
open-contracting · Aug 24, 2023 · 402c2e9 · 402c2e9
1 parent 90c2d22
commit 402c2e9
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 25 deletions.
diff --git a/docs/python/documentation.rst b/docs/python/documentation.rst
@@ -143,23 +143,25 @@ Create a ReadTheDocs project
 Configure the ReadTheDocs project
 ---------------------------------
 
--  For an application:
+.. tab-set::
 
-   .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/.readthedocs.yaml
-      :language: yaml
-      :caption: .readthedocs.yaml
+   .. tab-item:: Application
 
-   .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/docs/requirements.txt
-      :caption: docs/requirements.txt
+      .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/.readthedocs.yaml
+         :language: yaml
+         :caption: .readthedocs.yaml
 
--  For a package:
+      .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/docs/requirements.txt
+         :caption: docs/requirements.txt
 
-   .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/.readthedocs.yaml
-      :language: yaml
-      :caption: .readthedocs.yaml
+   .. tab-item:: Package
 
-   .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/docs/requirements.txt
-      :caption: docs/requirements.txt
+      .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/.readthedocs.yaml
+         :language: yaml
+         :caption: .readthedocs.yaml
+
+      .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/docs/requirements.txt
+         :caption: docs/requirements.txt
 
 .. note::
 

diff --git a/docs/python/linting.rst b/docs/python/linting.rst
@@ -8,13 +8,46 @@ Configuration
 
 New projects should use `Black <https://black.readthedocs.io/en/stable/>`__. All projects must use `flake8 <https://flake8.pycqa.org/en/latest/>`__ and `isort <https://pycqa.github.io/isort/>`__ with line lengths of 119 (the Django standard). If using Black, `configure it <https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html>`__ as follows:
 
-.. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/pyproject.toml
-   :language: yaml
-   :caption: pyproject.toml
+.. tab-set::
+
+   .. tab-item:: Python
+
+      .. code-block:: yaml
+         :caption: pyproject.toml
+
+         [tool.black]
+         line-length = 119
+
+         [tool.isort]
+         profile = 'black'
+         line_length = 119
+
+      .. code-block:: ini
+         :caption: setup.cfg
+
+         [flake8]
+         max-line-length = 119
+         extend-ignore = E203
 
-.. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/setup.cfg
-   :language: ini
-   :caption: setup.cfg
+   .. tab-item:: Package
+
+      .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/pyproject.toml
+         :language: yaml
+         :caption: pyproject.toml
+
+      .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/setup.cfg
+         :language: ini
+         :caption: setup.cfg
+
+   .. tab-item:: Django
+
+      .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/pyproject.toml
+         :language: yaml
+         :caption: pyproject.toml
+
+      .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/setup.cfg
+         :language: ini
+         :caption: setup.cfg
 
 Repositories should not modify or otherwise use ``pyproject.toml``, ``setup.cfg``, ``.editorconfig`` or tool-specific files, except to ignore generated files like database migrations. ``pyproject.toml`` is preferred to tool-specific files; if it's not supported, ``setup.cfg`` is preferred – like for `Flake8 <https://github.com/PyCQA/flake8/issues/234>`__ and `Babel <https://github.com/python-babel/babel/issues/777>`__.
 
@@ -38,16 +71,18 @@ Pre-commit hooks
 
 To avoid pushing commits that fail formatting/linting checks, new projects should use `pre-commit <https://pre-commit.com>`__ (add ``pre-commit`` to the :doc:`requirements_dev.in file<requirements>`. For example, if Black is configured as above, create a ``.pre-commit-config.yaml`` file:
 
--  For an application:
+.. tab-set::
+
+   .. tab-item:: Application
 
-   .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
-      :language: yaml
-      :end-before: migrations
+      .. literalinclude:: ../../cookiecutter-django/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
+         :language: yaml
+         :end-before: migrations
 
--  For a package:
+   .. tab-item:: Package
 
-   .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/.pre-commit-config.yaml
-      :language: yaml
+      .. literalinclude:: ../../cookiecutter-pypackage/{{cookiecutter.repository_name}}/.pre-commit-config.yaml
+         :language: yaml
 
 To ignore generated files, you can add, for example, ``exclude: /migrations/`` to the end of the file.