Skip to content

Commit

Permalink
rerun with latest macos
Browse files Browse the repository at this point in the history
  • Loading branch information
dbdimitrov committed Jul 18, 2024
1 parent bc9d3cc commit 30b9d2f
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
build-macOS:

runs-on: macOS-11.0
runs-on: macOS-latest

steps:
- uses: actions/checkout@v2
Expand Down
38 changes: 19 additions & 19 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Contributing Guide
==================

Scanpy provides extensive developer documentation <https://scanpy.readthedocs.io/en/stable/dev/index.html>_, most of which applies to this repo, too. This document will not reproduce the entire content from there. Instead, it aims at summarizing the most important information to get you started on contributing.
Scanpy provides extensive `developer documentation <https://scanpy.readthedocs.io/en/stable/dev/index.html>`_, most of which applies to this repo, too. This document will not reproduce the entire content from there. Instead, it aims at summarizing the most important information to get you started on contributing.

We assume that you are already familiar with git and with making pull requests on GitHub. If not, please refer to the developer documentation <https://scanpy.readthedocs.io/en/stable/dev/index.html>_.
We assume that you are already familiar with git and with making pull requests on GitHub. If not, please refer to the `developer documentation <https://scanpy.readthedocs.io/en/stable/dev/index.html>`_.

Installing Dev Dependencies
----------------------------
Expand All @@ -19,20 +19,20 @@ In addition to the packages needed to *use* this package, you need additional Py
Code-style
----------

This package uses pre-commit <https://pre-commit.com/>_ to enforce consistent code-styles. On every commit, pre-commit checks will either automatically fix issues with the code or raise an error message.
This package uses `pre-commit <https://pre-commit.com/>`_ to enforce consistent code-styles. On every commit, pre-commit checks will either automatically fix issues with the code or raise an error message.

To enable pre-commit locally, simply run

.. code-block:: bash
pre-commit install
Most editors also offer an *autoformat on save* feature. Consider enabling this option for black <https://black.readthedocs.io/en/stable/integrations/editors.html>_ and prettier <https://prettier.io/docs/en/editors.html>_.
Most editors also offer an *autoformat on save* feature. Consider enabling this option for `black <https://black.readthedocs.io/en/stable/integrations/editors.html>`_ and `prettier <https://prettier.io/docs/en/editors.html>`_.

Writing Tests
-------------

This package uses pytest <https://docs.pytest.org/en/8.2.x/>_ for automated testing. Please write tests <https://scanpy.readthedocs.io/en/latest/dev/testing.html#writing-tests>_ for every function added to the package.
This package uses `pytest <https://docs.pytest.org/en/8.2.x/>`_ for automated testing. Please write `tests <https://scanpy.readthedocs.io/en/latest/dev/testing.html#writing-tests>`_ for every function added to the package.

Most IDEs integrate with pytest and provide a GUI to run tests. Alternatively, you can run all tests from the command line by executing

Expand All @@ -48,7 +48,7 @@ Publishing a Release
Updating the Version Number
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Before making a release, you need to update the version number. Please adhere to Semantic Versioning <https://semver.org/>_, in brief
Before making a release, you need to update the version number. Please adhere to `Semantic Versioning <https://semver.org/>`_, in brief

Given a version number MAJOR.MINOR.PATCH, increment the:

Expand All @@ -58,7 +58,7 @@ Before making a release, you need to update the version number. Please adhere to

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

We use bump2version <https://pypi.org/project/bump2version/>_ to automatically update the version number in all places and automatically create a git tag. Run one of the following commands in the root of the repository
We use `bump2version <https://pypi.org/project/bump2version/>`_ to automatically update the version number in all places and automatically create a git tag. Run one of the following commands in the root of the repository

.. code-block:: bash
Expand All @@ -83,9 +83,9 @@ Python packages are not distributed as source code, but as *distributions*. The
python -m build
This command creates a *source archive* and a *wheel*, which are required for publishing your package to PyPI <https://pypi.org/project/liana/>_. These files are created directly in the root of the repository.
This command creates a *source archive* and a *wheel*, which are required for publishing your package to `PyPI <https://pypi.org/project/liana/>`_. These files are created directly in the root of the repository.

Before uploading them to PyPI <https://pypi.org/project/liana/>_, you can check that your *distribution* is valid by running:
Before uploading them to `PyPI <https://pypi.org/project/liana/>`_, you can check that your *distribution* is valid by running:

.. code-block:: bash
Expand All @@ -97,23 +97,23 @@ and finally publishing it with:
twine upload dist/*
Provide your username and password when requested and then go check out your package on PyPI <https://pypi.org/project/liana/>_!
Provide your username and password when requested and then go check out your package on `PyPI <https://pypi.org/project/liana/>`_!

For more information, refer to the python packaging tutorial <https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives>_ and pypi-feature-request <https://github.com/scverse/cookiecutter-scverse/issues/88>_.
For more information, refer to the `python packaging tutorial <https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives>`_ and `pypi-feature-request <https://github.com/scverse/cookiecutter-scverse/issues/88>`_.

Writing Documentation
----------------------

Please write documentation for new or changed features and use-cases. This project uses sphinx <https://www.sphinx-doc.org/en/master/>_ with the following features:
- Numpy-style docstrings <https://numpydoc.readthedocs.io/en/latest/>_
- Sphinx autodoc typehints <https://github.com/agronholm/sphinx-autodoc-typehints>_, to automatically reference annotated input and output types
- Docs use the furo <https://pradyunsg.me/furo/quickstart/>_ theme.
Please write documentation for new or changed features and use-cases. This project uses `sphinx <https://www.sphinx-doc.org/en/master/>`_ with the following features:
- `Numpy-style docstrings <https://numpydoc.readthedocs.io/en/latest/>`_
- `Sphinx autodoc typehints <https://github.com/agronholm/sphinx-autodoc-typehints>`_, to automatically reference annotated input and output types
- Docs use the `furo <https://pradyunsg.me/furo/quickstart/>`_ theme.

See the scanpy developer docs <https://scanpy.readthedocs.io/en/latest/dev/documentation.html>_ for more information on how to write documentation.
See the `scanpy developer docs <https://scanpy.readthedocs.io/en/latest/dev/documentation.html>`_ for more information on how to write documentation.

Upon every commit to the main branch, the documentation will be automatically built and published to readthedocs <https://liana-py.readthedocs.io/en/latest/>_.
Upon every commit to the main branch, the documentation will be automatically built and published to `readthedocs <https://liana-py.readthedocs.io/en/latest/>`_.

Tutorials with myst-nb and Jupyter Notebooks
Tutorials with Jupyter Notebooks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The documentation is set-up to render jupyter notebooks stored in the docs/notebooks.
Expand All @@ -128,7 +128,7 @@ Building the Docs Locally
cd docs
make clean
make html
open _build/html/index.html
open _uild/html/index.html
Contributing to the Codebase
----------------------------
Expand Down

0 comments on commit 30b9d2f

Please sign in to comment.