| 85 | |
| 86 | @nox.session |
| 87 | def docs(session: nox.Session) -> None: |
| 88 | install(session, ".[docs,docstest,sdist,ssh]") |
| 89 | |
| 90 | temp_dir = session.create_tmp() |
| 91 | session.run( |
| 92 | "sphinx-build", |
| 93 | "-T", |
| 94 | "-W", |
| 95 | "-b", |
| 96 | "html", |
| 97 | "-d", |
| 98 | f"{temp_dir}/doctrees", |
| 99 | "docs", |
| 100 | "docs/_build/html", |
| 101 | ) |
| 102 | session.run( |
| 103 | "sphinx-build", |
| 104 | "-T", |
| 105 | "-W", |
| 106 | "-b", |
| 107 | "latex", |
| 108 | "-d", |
| 109 | f"{temp_dir}/doctrees", |
| 110 | "docs", |
| 111 | "docs/_build/latex", |
| 112 | ) |
| 113 | |
| 114 | session.run( |
| 115 | "sphinx-build", |
| 116 | "-T", |
| 117 | "-W", |
| 118 | "-b", |
| 119 | "doctest", |
| 120 | "-d", |
| 121 | f"{temp_dir}/doctrees", |
| 122 | "docs", |
| 123 | "docs/_build/html", |
| 124 | ) |
| 125 | session.run( |
| 126 | "sphinx-build", |
| 127 | "-T", |
| 128 | "-W", |
| 129 | "-b", |
| 130 | "spelling", |
| 131 | "docs", |
| 132 | "docs/_build/html", |
| 133 | ) |
| 134 | |
| 135 | # This is in the docs job because `twine check` verifies that the README |
| 136 | # is valid reStructuredText. |
| 137 | session.run("python", "-m", "build", "--sdist") |
| 138 | session.run("twine", "check", "dist/*") |
| 139 | |
| 140 | |
| 141 | @nox.session(name="docs-linkcheck") |