[mkdocs] Add github action that tests the build of the example pages
Open
Nobody has claimed this yet.
bug
P1
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
Right now we build the examples from jupyter notebooks here
https://github.com/plotly/plotly.py/blob/main/.circleci/config.yml#L356-L388
If any notebook outputs an error the build fails and the docs won't publish
We need to implement something similar for the new docs so we don't end up showing failures on published pages
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the notebook build steps in .circleci/config.yml at lines 356-388 and compare them with the new MkDocs example-page build. Define the GitHub Actions check so notebook output errors fail the build before documentation publication; done means the workflow detects those failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, jupyter-notebook, python
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100