Skip to content

Commit 2722f8d

Browse files
committed
fix: serve or build mkdocs
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
1 parent 065e1d2 commit 2722f8d

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

docs/pages/guides/docs.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,12 +610,16 @@ with code_fence("python"):
610610
@nox.session(reuse_venv=True, default=False)
611611
def docs(session: nox.Session) -> None:
612612
"""
613-
Serve the docs
613+
Make or serve the docs. Pass --non-interactive to avoid serving.
614614
"""
615615
616616
doc_deps = nox.project.dependency_groups(PROJECT, "docs")
617617
session.install("-e.", *doc_deps)
618-
session.run("mkdocs", "serve", "--clean")
618+
619+
if session.interactive:
620+
session.run("mkdocs", "serve", "--clean", *session.posargs)
621+
else:
622+
session.run("mkdocs", "build", "--clean", *session.posargs)
619623
```
620624
<!-- prettier-ignore-end -->
621625
<!-- [[[end]]] -->

{{cookiecutter.project_name}}/noxfile.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
from __future__ import annotations
22

3-
{%- if cookiecutter.docs == 'sphinx' %}
4-
3+
{% if cookiecutter.docs == 'sphinx' -%}
54
import argparse
6-
7-
{%- endif %}
8-
5+
{% endif -%}
96
import shutil
107
from pathlib import Path
118

@@ -109,12 +106,16 @@ def build_api_docs(session: nox.Session) -> None:
109106
@nox.session(reuse_venv=True, default=False)
110107
def docs(session: nox.Session) -> None:
111108
"""
112-
Serve the docs
109+
Make or serve the docs. Pass --non-interactive to avoid serving.
113110
"""
114111

115112
doc_deps = nox.project.dependency_groups(PROJECT, "docs")
116113
session.install("{% if cookiecutter.backend != "mesonpy" %}-e{% endif %}.", *doc_deps)
117-
session.run("mkdocs", "serve", "--clean")
114+
115+
if session.interactive:
116+
session.run("mkdocs", "serve", "--clean", *session.posargs)
117+
else:
118+
session.run("mkdocs", "build", "--clean", *session.posargs)
118119

119120

120121
{%- endif %}

0 commit comments

Comments
 (0)