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

updating dox and fixing doc link issue #58

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions .github/workflows/tox-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
23 changes: 15 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,28 @@ 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
<https://github.com/karllark/dust_attenuation/issues>`_.

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
contributors who will abide by the `Python Software Foundation Code of Conduct
<https://www.python.org/psf/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 <https://docs.astropy.org/en/stable/development/workflow/development_workflow.html>`_

* `Coding Guidelines <https://docs.astropy.org/en/stable/development/codeguide.html>`_

* `Developer Documentation <https://docs.astropy.org/en/latest/index_dev.html>`_
`Astropy`_. Take a look at the astropy
`developer <https://docs.astropy.org/en/latest/index_dev.html>`_ documentation for
guidelines.

For the complete list of contributors please see the `dust_attenuation
contributors page on Github
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tox]
envlist =
py{39,310,311}-test{,-alldeps}{,-cov}
py{310,311,312}-test{,-alldeps}{,-cov}
build_docs
linkcheck
codestyle
Expand Down
Loading