Docs preview on PRs

16 views
Skip to first unread message

Aaron Meurer

unread,
May 9, 2022, 3:54:16 PM5/9/22
to sympy
We now have documentation preview builds on pull requests. At the
bottom of the build in the CI statuses, you should now see a status
that says "Click here to see a preview of the documentation." This
will take you to a build of the docs for that PR. Existing PRs will
need to merge in the latest master to get this to work.

For example, at https://github.com/sympy/sympy/pull/23293 you can see
the preview here
https://output.circle-artifacts.com/output/job/d30e6a0f-218e-4e74-8681-07944f0dd736/artifacts/0/doc/_build/html/explanation/glossary.html
(reviews of that PR are welcome too :-)

Please make use of this feature when reviewing to make sure any
documentation changes render correctly.

Aaron Meurer

Jeremy Monat

unread,
May 9, 2022, 4:37:28 PM5/9/22
to sy...@googlegroups.com
This is a great feature--contributors will no longer have to take screenshots to share the documentation outputs, nor will reviewers have to build the documentation themselves. Thanks, Aaron!

Jeremy Monat


--
You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAKgW%3D6J%3Dnsy72h23P59BXJS8c%2BecGyGN3hEJm0Pj%3DxmqFFixKA%40mail.gmail.com.
Reply all
Reply to author
Forward
0 new messages