Skip to content

Commit 1526efd

Browse files
committed
docs: Add note about updating plotly.py version in API docs config
1 parent b4fed1a commit 1526efd

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

‎doc/README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ At release time the synchronization is bidirectional (see also
8888
> release, update the `plotly==` version pin in `doc/requirements.txt` to match
8989
> the newly released version. The `doc-prod` build uses this pinned version
9090
> (not an editable install), so examples that rely on new features will fail
91-
> if the pin is stale.
91+
> if the pin is stale. Set the `release` string in `doc/apidoc/conf.py` to the
92+
> same version, because the API reference shows that string as the version of
93+
> the documented release.
9294
9395
### Tutorial file format
9496

@@ -311,7 +313,10 @@ corresponding `.rst` file to appear in the API doc.
311313
- `css` files are found in `_static`
312314
- Template files are found in `_templates`. `.rst` templates describe how the
313315
autodoc of the different objects should look like.
314-
- `conf.py` contains the Sphinx configuration (theme, extensions, etc.)
316+
- `conf.py` contains the Sphinx configuration (theme, extensions, etc.). Its
317+
`release` string gives the version that the API reference shows, so each
318+
release must update it. See
319+
[Keeping `main` and `doc-prod` in sync](#keeping-main-and-doc-prod-in-sync).
315320

316321
## CI/CD pipeline
317322

0 commit comments

Comments
 (0)