You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,6 @@ Initiatives.
24
24
25
25
## Contributing statement
26
26
27
-
28
27
## How to setup
29
28
30
29
This repository contains the source files for the [pyOpenSci Python packaging guide](https://pyopensci.org/python-package-guide).
@@ -44,44 +43,49 @@ To build, follow these steps:
44
43
1. Install `nox`
45
44
46
45
```console
47
-
$ python -m pip install nox
46
+
python -m pip install nox
48
47
```
48
+
49
49
2. Build the documentation:
50
50
51
51
```console
52
-
$ nox -s docs
52
+
nox -s docs
53
53
```
54
54
55
55
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
56
56
57
57
To build live documentation that updates when you update local files, run the following command:
58
58
59
59
```console
60
-
$ nox -s docs-live
60
+
nox -s docs-live
61
61
```
62
62
63
+
If you are a uv user, you can also skip installing `nox` and use `uvx` instead:
64
+
65
+
`uvx nox -s docs-live`
66
+
63
67
### Building for release
64
68
65
69
When building for release, the docs are built multiple times for each translation,
66
70
but translations are only included in the production version of the guide after some completion threshold.
67
71
68
72
The sphinx build environment is controlled by an environment variable `SPHINX_ENV`
69
73
70
-
- when `SPHINX_ENV=development` (default), sphinx assumes all languages are built,
74
+
* when `SPHINX_ENV=development` (default), sphinx assumes all languages are built,
71
75
and includes them in the language selector
72
-
- when `SPHINX_ENV=production`, only those languages in `release_languages` (set in `conf.py`)
76
+
* when `SPHINX_ENV=production`, only those languages in `release_languages` (set in `conf.py`)
73
77
are built and included in the language selector.
74
78
75
79
Most of the time you should not need to set `SPHINX_ENV`,
76
80
as it is forced by the primary nox sessions intended to be used for release or development:
77
81
78
82
`SPHINX_ENV=development`
79
-
-`docs-live` - autobuild english
80
-
-`docs-live-lang` - autobuild a single language
81
-
-`docs-live-langs` - autobuild all languages
83
+
*`docs-live` - autobuild english
84
+
*`docs-live-lang` - autobuild a single language
85
+
*`docs-live-langs` - autobuild all languages
82
86
83
87
`SPHINX_ENV=production`
84
-
-`build-test` - build all languages for production
88
+
*`build-test` - build all languages for production
0 commit comments