Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change to tab layout for pyproject.toml vs setup.cfg #1155

Merged
merged 2 commits into from
Jun 20, 2022

Conversation

WilliamJamieson
Copy link
Contributor

Changes layout for pyproject.toml vs setup.cfg examples from listing consecutively to placing them on user selectable tabs.

Copy link
Member

@zacharyburnett zacharyburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me, I've added links to the relevant parts of the built docs for reference

@@ -253,18 +253,20 @@ We'll assume that method is located in the module ``asdf_foo_extension.integrati
Next, in the package's ``pyproject.toml``, define a ``[project.entry-points]`` section (or ``[options.entry_points]`` in
``setup.cfg``) that identifies the method as an ``asdf.extensions`` entry point:

.. code-block:: toml
.. tab:: pyproject.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -881,17 +881,19 @@ containing your schema files to the pytest section of your project's build confi
(``pyproject.toml`` or ``setup.cfg``). If you do not already have such a file, creating
one with the following should be sufficient:

.. code:: toml
.. tab:: pyproject.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -221,17 +223,19 @@ YAML files. There are multiple ways to accomplish this, but one easy option
is to add a ``[tool.setuptools.package-data]`` section to ``pyproject.toml`` (or ``[options.package_data]`` in
``setup.cfg``) requesting that all files with a ``.yaml`` extension be installed:

.. code-block:: toml
.. tab:: pyproject.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -193,17 +193,19 @@ instance:
Then in ``pyproject.toml``, define an ``[project.entry-points]`` section (or ``[options.entry_points]`` in ``setup.cfg``)
that identifies the method as an ``asdf.resource_mappings`` entry point:

.. code-block:: toml
.. tab:: pyproject.toml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zacharyburnett zacharyburnett merged commit 5db3e9b into asdf-format:master Jun 20, 2022
@WilliamJamieson WilliamJamieson deleted the docs/pyproject branch June 20, 2022 19:14
WilliamJamieson added a commit to WilliamJamieson/asdf that referenced this pull request Aug 17, 2022
* Change to tab layout for pyproject vs setup.cfg

* Update changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants