-
Notifications
You must be signed in to change notification settings - Fork 894
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Better docs builds #4563
Better docs builds #4563
Conversation
As a note, I was running |
Based on the docs-test-fork PR branch, includes PR preview announcement, linking to the relevant tyrtd page
Swap `cp -u` for `rsync -t`. Drop the workaround to get the list of dot files after copying them, and instead just run the makefile twice. Swap `$(wildcard **/*.x)` for `$(shell find . -name *.x)`,
Which is what the comment said, but the code didn't match.
Trigger on main, on a branch called `docs-preview*`, or on any tag.
Latest still gets -dev, but if it's a docs preview use the tag/branch name.
acb608f
to
ecff434
Compare
Fix outstanding sphinx warnings; - Change mycells.lib to use `text` parsing instead of (currently) unsupported `Liberty`. - Remove unused `troubleshooting.rst`, moving the todo into the index.
fcb94ba
to
977118a
Compare
Docs jobs should not skip on concurrent jobs (in case a non-docs job is already running, such as when a commit has been tagged for docs-preview). However, a successful `test-verific` can allow for a future docs job to skip testing and go straight to the preview.
977118a
to
6c833d8
Compare
That includes local builds. Also fix release version numbers.
What are the reasons/motivation for this change?
Explain how this is achieved.
READTHEDOCS
andGITHUB_TOKEN
environment variables. This also has some changes to (better) support building on mac and other small formatting fixes..readthedocs.yaml
to fail if sphinx raises any warnings, notably because it's missing files. This also involves fixing the couple of warnings that were still popping up. I also ended up splitting theprepare-docs
job from thetest-verific
in order to better control when the job would run. There is an extra change so that todos appear in preview builds but not in release builds.If applicable, please suggest to reviewers how they can test the change.
Run
make docs
locally. Check docs-previewtest tag (https://yosyshq.readthedocs.io/projects/yosys/en/docs-previewtest/).