From 8422f44327bf18b7dde10cd2c245667354207c41 Mon Sep 17 00:00:00 2001 From: Karl Gordon Date: Mon, 16 Sep 2024 08:11:24 -0400 Subject: [PATCH] updating dox and fixing doc link issue --- .github/workflows/tox-tests.yml | 36 ++++++++++++++++----------------- docs/index.rst | 23 +++++++++++++-------- tox.ini | 2 +- 3 files changed, 34 insertions(+), 27 deletions(-) diff --git a/.github/workflows/tox-tests.yml b/.github/workflows/tox-tests.yml index 32b7bc4..9ae1ed8 100644 --- a/.github/workflows/tox-tests.yml +++ b/.github/workflows/tox-tests.yml @@ -28,15 +28,15 @@ jobs: os: [ubuntu-latest, macos-latest, windows-latest] # Test python version 3.x - python-ver: [9, 10, 11] + python-ver: [10, 11, 12] # Specify which tox environments to test in this list. # tox-env: [cov, alldeps, devdeps, astropylts] tox-env: [alldeps] steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Set up python 3.${{ matrix.python-ver }} with tox environment py3${{ matrix.python-ver }}-${{ matrix.tox-env }} on ${{ matrix.os }} - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: python-version: 3.${{ matrix.python-ver }} - name: Install base dependencies @@ -70,38 +70,38 @@ jobs: runs-on: ubuntu-latest if: "!contains(github.event.head_commit.message, '[ci skip]')" steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Set up python for astropy lts test - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: - python-version: 3.9 + python-version: 3.11 - name: Install base dependencies run: | python -m pip install --upgrade pip python -m pip install tox - name: Test with tox run: | - tox -e py39-astropylts + tox -e py311-astropylts # Coverage test cov_test: runs-on: ubuntu-latest if: "!contains(github.event.head_commit.message, '[ci skip]')" steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Set up python for coverage test - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: - python-version: 3.11 + python-version: 3.12 - name: Install base dependencies run: | python -m pip install --upgrade pip python -m pip install tox - name: Test with tox run: | - tox -e py311-cov + tox -e py312-cov - name: Upload coverage to codecov - uses: codecov/codecov-action@v1 + uses: codecov/codecov-action@v4 with: token: ${{ secrets.CODECOV }} fail_ci_if_error: true @@ -118,11 +118,11 @@ jobs: runs-on: ubuntu-latest if: "!contains(github.event.head_commit.message, '[ci skip]')" steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Set up Python to build docs with sphinx - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: - python-version: 3.11 + python-version: 3.12 - name: Install base dependencies run: | python -m pip install --upgrade pip @@ -138,11 +138,11 @@ jobs: runs-on: ubuntu-latest if: "!contains(github.event.head_commit.message, '[ci skip]')" steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Python codestyle check - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: - python-version: 3.11 + python-version: 3.12 - name: Install base dependencies run: | python -m pip install --upgrade pip diff --git a/docs/index.rst b/docs/index.rst index 6572c30..091abe6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,6 +64,18 @@ developers will walk you through obtaining a stack trace if it is necessary. Contributing ============ +If you have found a bug in ``dust_attenuation`` please report it by creating a +new issue on the ``dust_attenuation`` `GitHub issue tracker +`_. + +Please include an example that demonstrates the issue sufficiently so that the +developers can reproduce and fix the problem. You may also be asked to provide +information about your operating system and a full Python stack trace. The +developers will walk you through obtaining a stack trace if it is necessary. + +Contributing +============ + Like the `Astropy`_ project, ``dust_attenuation`` is made both by and for its users. We accept contributions at all levels, spanning the gamut from fixing a typo in the documentation to developing a major new feature. We welcome @@ -71,14 +83,9 @@ contributors who will abide by the `Python Software Foundation Code of Conduct `_. ``dust_attenuation`` follows the same workflow and coding guidelines as -`Astropy`_. The following pages will help you get started with contributing -fixes, code, or documentation (no git or GitHub experience necessary): - -* `How to make a code contribution `_ - -* `Coding Guidelines `_ - -* `Developer Documentation `_ +`Astropy`_. Take a look at the astropy +`developer `_ documentation for +guidelines. For the complete list of contributors please see the `dust_attenuation contributors page on Github diff --git a/tox.ini b/tox.ini index 8eae1c9..0b01bb5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] envlist = - py{39,310,311}-test{,-alldeps}{,-cov} + py{310,311,312}-test{,-alldeps}{,-cov} build_docs linkcheck codestyle