Skip to content

Commit

Permalink
Make Sphinx documentation build not dependent on nox (#1368)
Browse files Browse the repository at this point in the history
* Removed nox from doc build
* Fix pytest run for cmd2-ext-test and try to fix doc build
  • Loading branch information
tleonhardt authored Nov 3, 2024
1 parent 2dea62e commit 99358d4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 18 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
- name: Install python prerequisites
run: pip install -U --user pip setuptools setuptools-scm nox
run: pip install -U --user pip setuptools setuptools-scm sphinx sphinx-autobuild sphinx-rtd-theme . plugins/ext_test
- name: Sphinx documentation build
run: python -m nox --non-interactive --session docs
run: python -m sphinx -M html docs docs/_build -nvWT
16 changes: 0 additions & 16 deletions noxfile.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,6 @@
import nox


@nox.session(python=['3.12'])
def docs(session):
session.install(
'sphinx',
'sphinx-rtd-theme',
'.',
'plugins/ext_test',
)
session.chdir('docs')
tmpdir = session.create_tmp()

session.run(
'sphinx-build', '-a', '-W', '-T', '-b', 'html', '-d', '{}/doctrees'.format(tmpdir), '.', '{}/html'.format(tmpdir)
)


@nox.session(python=['3.8', '3.9', '3.10', '3.11', '3.12', '3.13'])
@nox.parametrize('plugin', [None, 'ext_test', 'template', 'coverage'])
def tests(session, plugin):
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ packages = ["cmd2"]

[tool.uv]
dev-dependencies = [
"cmd2-ext-test",
"codecov",
"doc8",
"invoke",
Expand All @@ -333,3 +334,6 @@ dev-dependencies = [
"ruff",
"twine",
]

[tool.uv.sources]
cmd2-ext-test = { path = "plugins/ext_test", editable = true }

0 comments on commit 99358d4

Please sign in to comment.