Skip to content

Commit

Permalink
Merge pull request #11 from adambaskerville/cookiecutter
Browse files Browse the repository at this point in the history
Changed docs_build
  • Loading branch information
adambaskerville authored Feb 18, 2024
2 parents 32cebda + 2aecba3 commit 5b29c38
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
7 changes: 2 additions & 5 deletions .github/workflows/docs-build-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,12 @@ jobs:
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Set up Python 3.10
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
cache: 'pip'
- name: Building docs
run: |
pip install nox
nox -s docs_build-3.10
nox -s docs_build
- uses: actions/upload-pages-artifact@v2
with:
Expand Down
6 changes: 3 additions & 3 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,16 +120,16 @@ def dist_build(session: nox.Session) -> None:
session.run("python", "-m", "build")


@nox.session(venv_backend="conda", python=SUPPORTED_PYTHON_VERSIONS)
@nox.session()
def docs_build(session: nox.Session) -> None:
"""Build sphinx documentation and API docs.
Examples:
nox -s docs_build-3.10
"""

lockfile_path = resolve_lockfile_path(python_version=session.python)
session.install(".[docs]", "--constraint", lockfile_path)
#lockfile_path = resolve_lockfile_path(python_version=session.python)
#session.install(".[docs]", "--constraint", lockfile_path)

# # Build API docs
# session.run(*apidoc_cmd.split(" "))
Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ dependencies = [
'pidng>=3.4.7',
'Pillow>=8.4.0',
'PySimpleGUI<=4.60.5',
'sphinx!=5.1.0',
'sphinx-sitemap',
'sphinx-inline-tabs',
'sphinx-book-theme',
'sphinx_design',
'sphinx-toolbox',
'sphinx_togglebutton',
'jupytext>=1.11.2',
'myst-nb',
]

[project.optional-dependencies]
Expand Down

0 comments on commit 5b29c38

Please sign in to comment.