From 3e71493621bbf1b5c6c6ec063a06694a8f4843b2 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Wed, 15 Jan 2025 14:52:21 -0500 Subject: [PATCH] docs: fix minor typos, links --- doc/source/conda-forge-guide.rst | 22 ++++++++++------------ doc/source/frequently-asked-questions.rst | 4 ++-- doc/source/getting-started.rst | 2 +- doc/source/index.rst | 2 +- doc/source/release-guide.rst | 2 +- doc/source/scikit-package-guide.rst | 2 +- news/jan-15-docs.rst | 23 +++++++++++++++++++++++ 7 files changed, 39 insertions(+), 18 deletions(-) create mode 100644 news/jan-15-docs.rst diff --git a/doc/source/conda-forge-guide.rst b/doc/source/conda-forge-guide.rst index fe199f9..f8e173d 100644 --- a/doc/source/conda-forge-guide.rst +++ b/doc/source/conda-forge-guide.rst @@ -24,7 +24,7 @@ The process is divided into three steps: 1. :ref:`Prepare recipe: ` You will learn to prepare package information in a file called ``meta.yaml`` using our group's scikit-package template. The file serves as a recipe for building your conda package. The recipe contains the package version, the source code, the dependencies, the license, etc. -2. :ref:`Upload therecipe: ` Once you have the ``meta.yaml`` generated, you will create a pull request the staged-recipe repository in the conda-forge repository `here `_ +2. :ref:`Upload the recipe: ` Once you have the ``meta.yaml`` generated, you will create a pull request the staged-recipe repository in the conda-forge repository `here `_ 3. :ref:`Recipe review: ` One of the community members of conda-forge will review your ``meta.yaml`` and provide feedback. Once the recipe is approved, you will have a package available for ``conda install`` automatically, and you will have your own designated feedstock repository that contains ``meta.yaml`` in ``https://github.com/conda-forge/-feedstock``. @@ -51,23 +51,23 @@ If you are interested in learning more about each component within ``meta.yaml`` :version: The version of the package. - :Select: Choose PyPI. PyPI's ``sdist`` containing requirements files, src/tests, and ``pyproject.toml`` + :source: Choose PyPI. - :short_description: A short description of the project + :short_description: The short description of the project. - :full_description: A full description of the project + :full_description: The full description of the project. :license_file: The license file that is located in your project repository. i.e., ``LICENSE.rst``. - :maintainers: You may have multiple maintainers ``sbillinge, bobleesj`` or just ``sbillinge`` + :maintainers: You may have multiple maintainers ``sbillinge, bobleesj`` or just ``sbillinge``. - :build_requirements: copy ``requirements/build.txt`` from the project repo. It should be empty for pure Python packages, otherwise compilers will be required. + :build_requirements: copy ``requirements/build.txt`` from the project repo. It should be empty for pure Python packages. - :host_requirements: Copy the following for the ``python >=3.11, setuptools, setuptools-git-versioning >=2.0, pip``. Copy ``requirements/host.txt`` + :host_requirements: Type ``python >=3.11, setuptools, setuptools-git-versioning >=2.0, pip`` from ``requirements/host.txt``. - :runtime_requirements: copy ``requirements/conda.txt``: + :runtime_requirements: Type the runtime dependencies from ``requirements/conda.txt``. - :testing_requirements: copy ``requirements/test.txt`` + :testing_requirements: Type the testing dependencies from ``requirements/test.txt``. Now, you have ``recipes//meta.yaml`` generated. @@ -104,7 +104,6 @@ Now, you have ``recipes//meta.yaml`` generated. .. _conda-forge-recipe-review: - 3. Wait for recipe review ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -112,7 +111,6 @@ Now, you have ``recipes//meta.yaml`` generated. 2. Once the PR is merged by the reviewer (1) your package is available on conda-forge, and (2) a new repository will be created under https://github.com/conda-forge/package-name-feedstock/. Example: https://github.com/conda-forge/diffpy.structure-feedstock. - .. _conda-forge-feedstock-release: Use the conda-forge feedstock to release a new version @@ -120,7 +118,7 @@ Use the conda-forge feedstock to release a new version We release a new package once we have the ``version`` and ``SHA256`` sections in ``meta.yaml`` in ``https://github.com/conda-forge/-feedstock`` located in the ``main`` branch. The conda-forge team asks to only modify ``meta.yaml``. -First, we will attain th ``SHA256`` value from `pypi.org `_: +First, we will copy the ``SHA256`` value from `pypi.org `_: #. Visit the project on PyPI at ``https://pypi.org/project/`` diff --git a/doc/source/frequently-asked-questions.rst b/doc/source/frequently-asked-questions.rst index 9bdc529..779dba1 100644 --- a/doc/source/frequently-asked-questions.rst +++ b/doc/source/frequently-asked-questions.rst @@ -349,7 +349,7 @@ Other considerations for maintaining group infrastructure ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Be extremely careful with changes that are visible to users. -- Try not to pass down technical debt to future members. Do the extra work so that others can save time. i.e, making a PR to the scikit-package repo once an issue has been identified in a scikit-packageed project. +- Try not to pass down technical debt to future members. Do the extra work so that others can save time. i.e, making a PR to the scikit-package repo once an issue has been identified in a scikit-packaged project. reducing compute time, especially when computing resources are not the primary constraint. - It is easier to remove things (e.g., dependencies) we don't want than to add things that are needed in certain circumstances. @@ -453,7 +453,7 @@ Dependency management Why are both pip.txt and conda.txt provided? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Our preferred choice for installing the scikit-packageed package is as a Conda package, as outlined in the template ``README.rst`` file. With Conda, the end user can install all associated dependencies by running ``conda create --name new_env ``. Additionally, the environment is tested via conda-forge CI before the Conda package is released, which helps ensure the package's compatibility with its dependencies. Hence, we list conda package dependencies in ``conda.txt``. +Our preferred choice for installing the scikit-packaged package is as a Conda package, as outlined in the template ``README.rst`` file. With Conda, the end user can install all associated dependencies by running ``conda create --name new_env ``. Additionally, the environment is tested via conda-forge CI before the Conda package is released, which helps ensure the package's compatibility with its dependencies. Hence, we list conda package dependencies in ``conda.txt``. However, we also want to allow users to install the package via ``pip``. To support this, we provide a separate file for pip dependencies, ``pip.txt``. In most cases, the dependencies listed in ``conda.txt`` and ``pip.txt`` will be identical. However, there can be exceptions. For example, ``matplotlib-base`` is preferred for Conda installations, while ``matplotlib`` is used for pip installations. diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 20193f9..7c2289e 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -15,7 +15,7 @@ Are you here to standardize your Python project with scikit-package? 1. You have an existing Python project. Do you want to standardize your project with ``scikit-package``? Please follow the full instructions :ref:`here `. -2. You already have a scikit-packageed project. Do you want to use the latest version of ``scikit-package`` to re-standard your project? Please follow the instructions in :ref:`here `. +2. You already have a scikit-packaged project. Do you want to use the latest version of ``scikit-package`` to re-standard your project? Please follow the instructions in :ref:`here `. 3. Do you want to start a new Python project with ``scikit-package``? Start from the scikit-package workflow section :ref:`here `. diff --git a/doc/source/index.rst b/doc/source/index.rst index 016c263..4b2c26c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -95,7 +95,7 @@ Table of contents :maxdepth: 2 getting-started - skpackage-guide + scikit-package-guide release-guide conda-forge-guide frequently-asked-questions diff --git a/doc/source/release-guide.rst b/doc/source/release-guide.rst index 148e8c0..1368256 100644 --- a/doc/source/release-guide.rst +++ b/doc/source/release-guide.rst @@ -17,7 +17,7 @@ PyPI/GitHub release #. In the repository, create an issue on GitHub with the "Release" option as shown below: - .. image:: ./img/add-personal-access-token.png + .. image:: ./img/release-issue.png :alt: add-personal-access-token :width: 600px diff --git a/doc/source/scikit-package-guide.rst b/doc/source/scikit-package-guide.rst index d0c896d..853c4d0 100644 --- a/doc/source/scikit-package-guide.rst +++ b/doc/source/scikit-package-guide.rst @@ -5,7 +5,7 @@ .. _scikit-package-header: ========================================================== -How to standarlize your Python package with scikit-package +How to standarlize your Python project with scikit-package ========================================================== .. _scikit-package-installation: diff --git a/news/jan-15-docs.rst b/news/jan-15-docs.rst new file mode 100644 index 0000000..dad63a1 --- /dev/null +++ b/news/jan-15-docs.rst @@ -0,0 +1,23 @@ +**Added:** + +* no news added: fix minor typos in the docs and broken links. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*