Skip to content

Commit

Permalink
Merge pull request #92 from greglucas/doc-refs
Browse files Browse the repository at this point in the history
DOC: Update sphinx references
  • Loading branch information
greglucas authored Aug 30, 2023
2 parents 5d4ba7a + c49d44c commit 800a1ce
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 18 deletions.
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ repos:
- id: no-commit-to-branch
args: [--branch, main, --branch, dev]
- repo: https://github.com/psf/black
rev: 23.3.0
rev: 23.7.0
hooks:
- id: black
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: 'v0.0.277'
rev: 'v0.0.286'
hooks:
- id: ruff
args: [--fix]
- repo: https://github.com/python-poetry/poetry
rev: '1.5.0' # add version here
rev: '1.6.0' # add version here
hooks:
- id: poetry-check
- id: poetry-lock
Expand Down
2 changes: 1 addition & 1 deletion docs/source/development/style-guide/poetry-environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Poetry Environment
------------------

:ref:`_poetry-link <Poetry>` is used for dependency management within this project. To update dependencies, you can either update
:ref:`Poetry <poetry-link>` is used for dependency management within this project. To update dependencies, you can either update
``pyproject.toml`` manually, or use ``poetry add <dependency>``.

If you do add dependencies, please make sure you define the version numbers mindfully. The best way to do this is to use
Expand Down
4 changes: 2 additions & 2 deletions docs/source/development/style-guide/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ numbers should follow a convention of ``x.y.z``, where:
z = The hotfix number. Increase when change only contains bug fixes.

This convention was discussed and decided on in `this GitHub issue
<https://github.com/IMAP-Science-Operations-Center/imap_processing/issues/43>`_.
<https://github.com/IMAP-Science-Operations-Center/imap_processing/issues/43>`__.


Data Product Versioning
Expand All @@ -37,4 +37,4 @@ is only updated when that instrument's algorithm is changed, or that instrument'
updated independently of the other IMAP instruments.

This convention was discussed and decided on in `this GitHub issue
<https://github.com/IMAP-Science-Operations-Center/imap_processing/issues/48>`_.
<https://github.com/IMAP-Science-Operations-Center/imap_processing/issues/48>`__.
14 changes: 2 additions & 12 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 800a1ce

Please sign in to comment.