Skip to content

Conversation

@12rambau
Copy link
Contributor

@12rambau 12rambau commented Jan 31, 2023

Fix #239

In this PR I added a few configurations to build unit tests and documentation pages using nox. It creates isolated environments to ensure that the build will work when send to RDT. It's also the first step toward unit testing.

  • create 2 nox sessions: "lint" to run the pre-commits (assuming it will be merged) and "docs" to create the documentation in a docs/_build folder.
  • remove makefiles as they are nicely replaced by nox -s docs
  • add the nox-produced files to .gitignore
  • create a doc set of extra_requires to have everything needed for the documentation
  • set up a .readthedocs.yaml file so that the documentation is built using the correct env

As I need to check the RDT build there will surely be test commits, I assume you will just squash my PR so I'm just sorry for the noise.

@12rambau
Copy link
Contributor Author

@maartenbreddels, @mariobuikhuizen I would like the doc to be build on main (at least latest) but when I install in dev mode there are many npm command that start. Of course it wasn't an issue before because RDT was build from the pipy version.
Would you have any guidance ?

@maartenbreddels
Copy link
Collaborator

I never build on rtd, because there wasn’t enough memory. Why do you want to do that?

@12rambau
Copy link
Contributor Author

If I want to work on the API build in #238 I would like to make sure latest is on track with main. So I would need to run: pip install .[doc]

@maartenbreddels
Copy link
Collaborator

I think you should install Jupyter lab to be able to build

@12rambau
Copy link
Contributor Author

12rambau commented Jan 31, 2023

thanks @maartenbreddels for the tips. The complete solution was "install jupyterlab before the lib to enable the build of jupyter extentions when npm install will be called from the js folder to execute webpack scripts".

with the pre-install job, it works like a charm. This is then ready for review

@12rambau 12rambau marked this pull request as ready for review January 31, 2023 23:26
@12rambau 12rambau mentioned this pull request Feb 26, 2023
1 task
@12rambau
Copy link
Contributor Author

@maartenbreddels things were working just fine when I finished my PR: https://readthedocs.org/projects/ipyvuetify/builds/19602806/ but now I get NPM warnings/errors everywhere: https://readthedocs.org/projects/ipyvuetify/builds/19959839/

Is there something to change there ? like node version ? python version ?

@maartenbreddels maartenbreddels force-pushed the master branch 3 times, most recently from 368ca6d to e241012 Compare April 3, 2023 15:04
@12rambau
Copy link
Contributor Author

12rambau commented Apr 12, 2023

sorry for the noise. I made many tests from RDT side. I hope they will help me find a solution from their side: readthedocs/readthedocs.org#10223

@mariobuikhuizen
Copy link
Collaborator

This PR now depends on the fix in: #259

@12rambau
Copy link
Contributor Author

@mariobuikhuizen I rebased on the current master and solved the remaining RDT related issue. I think this one is also ready to go.

Copy link
Collaborator

@mariobuikhuizen mariobuikhuizen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good Thanks!

One small issue:

@mariobuikhuizen mariobuikhuizen merged commit 96c6266 into widgetti:master Aug 22, 2023
@12rambau 12rambau deleted the nox branch August 22, 2023 19:33
12rambau added a commit to 12rambau/ipyvuetify that referenced this pull request Aug 24, 2023
since widgetti#240, this is completely handled by the build
mariobuikhuizen pushed a commit that referenced this pull request Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

use nox to build the documentation and the tests ?

3 participants