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

Added docs dependencies and cruft update #29

Merged
merged 2 commits into from
Feb 10, 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
2 changes: 1 addition & 1 deletion .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/monarch-initiative/monarch-project-template/",
"commit": "e5f758215fa58b92093e71b632f804569fde9dba",
"commit": "9d4f915d4a4cd1a9d8206506db1e261bc397de9c",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ jobs:
branch: gh-pages
force: true
folder: gh-pages
token: ${{ secrets.GH_TOKEN }}
token: ${{ secrets.GH_TOKEN }}
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
import re
import sys
from datetime import date

from curate_gpt import __version__

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ sphinx-click = {version = ">=4.3.0", extras = ["docs"]}
sphinx-automodapi = {version = "*", extras = ["docs"]}
myst-parser = {version = ">=0.18.1", extras = ["docs"]}

[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
sphinx = {version = ">=6.1.3"}
sphinx-rtd-theme = {version = ">=1.0.0"}
sphinx-autodoc-typehints = {version = ">=1.2.0"}
sphinx-click = {version = ">=4.3.0"}
myst-parser = {version = ">=0.18.1"}

[tool.poetry.scripts]
curategpt = "curate_gpt.cli:main"
Expand Down
2 changes: 1 addition & 1 deletion src/curate_gpt/wrappers/general/github_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def get_token(token: str = None) -> Optional[str]:
return token
"""Get token from env var"""
token = os.environ.get("CURATEGPT_GITHUB_TOKEN")
#if not token:
# if not token:
# raise ValueError("CURATEGPT_GITHUB_TOKEN env var not set")
return token

Expand Down
10 changes: 5 additions & 5 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ deps =
ruff
skip_install = true
commands =
black src/ tests/
ruff --fix src/ tests/
black src/ tests/ --exclude "/(tests/input|tests/output)/"
ruff --fix src/ tests/ --exclude tests/input --exclude tests/output
description = Run linters.

# This is used for QC checks.
Expand All @@ -49,8 +49,8 @@ deps =
ruff
skip_install = true
commands =
black --check --diff src/ tests/
ruff check src/ tests/
black --check --diff src/ tests/ --exclude "/(tests/input|tests/output)/"
ruff check src/ tests/ --exclude tests/input --exclude tests/output
description = Run linters.

[testenv:doclint]
Expand All @@ -67,7 +67,7 @@ skip_install = true
deps =
codespell
tomli # required for getting config from pyproject.toml
commands = codespell src/ tests/
commands = codespell src/ tests/ -S tests/input/,tests/output/

[testenv:codespell-write]
description = Run spell checker and write corrections.
Expand Down
Loading