-
Notifications
You must be signed in to change notification settings - Fork 143
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
Fix docs tox environment #1775
Fix docs tox environment #1775
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huge thanks for doing the sleuthing. Up to you whether you want to change how the core library is installed or not.
4cd9682
to
48c8c9a
Compare
@@ -79,6 +79,7 @@ commands = | |||
changedir = {toxinidir} | |||
deps = -rrequirements/docs.txt | |||
commands = | |||
python -m pip install . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggested this pip install in another comment, however I think it may not be strictly necessary, since tox installs the package dependencies as part of it's environment setup. And merlin-core is specified in the package install requires.
I tried running this docs
and docs-multi
locally without this and both seem to produce the API docs with content, so might be some other reason they didn't populate
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm. ok, yeah then I'm stumped on what the problem would have been.
The API documentation was empty because
autosummary
couldn't import the source modules. I fixed this by installingmerlin-core
in the docs tox environment.I've also included a couple of small README changes: