Build docs PR preview on RTD #115
Conversation
|
Yay, it works! Please don't merge yet. I have a lot to fix here. |
- Use uv to set up a development environment - Update make commands
|
@datakurre I know nothing about nix. When I run tests locally on a single version of Python and Sphinx, they all pass. Can you help from this point forward? |
|
Yes. Thanks. It’s good for me learn these gaps. In theory, the setup should use uv.lock transpatently to support both worlds, but there are always devils in the details. |
|
@stevepiercy Thank you! Quite small changes to support both worlds. In short, nix environments are immutable, which disables some conveniences of the traditional tooling (but brings some benefits regarding reproducibility and security). Also, there is something I forgot to complete, requiring PYTHONPATH=docs for docs of this package. Volto team has been wishing to be able to generate code examples along other http-examples. Therefore 2.0 includes support for custom example builder modules, which are currently only documented on how https://github.com/collective/sphinxcontrib-httpexample/blob/master/docs/plone_client.py is integrated into example docs... |
|
@datakurre that's great to hear! For the custom builder for JavaScript, yup, that was me, Victor, and the author @Hrittik20 who were pushing for it. Is there something that you'd like me to change for this? I'm not clear if you're asking for help, but I'm happy to do whatever is helpful. Thank you! |
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
Everything LGTM. I checked it out locally, and was able to run the make commands.
Just heads up that it's there, but I've failed to continue with example and document it. 🙈 |
- Refactor build_plone_javascript_command to build_plone_client_command - Expand documentation of custom builder - Fix heading levels
Documentation build overview
Show files changed (3 files in total): 📝 3 modified | ➕ 0 added | ➖ 0 deleted
|
|
@datakurre I'm still not absolutely clear what to do, but I made a few changes. The example is for Then I looked at the relevant issues and PRs, but I'm not sure what you have in mind.
@sneridagh @robgietema can you help fill in details of what you'd like to see? Please let me know. Thank you! |
📚 Documentation preview 📚: https://sphinxcontrib-httpexample--115.org.readthedocs.build/