Skip to content
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

Merged
merged 7 commits into from
Mar 21, 2023
Merged

Fix docs tox environment #1775

merged 7 commits into from
Mar 21, 2023

Conversation

alexanderronquillo
Copy link
Contributor

The API documentation was empty because autosummary couldn't import the source modules. I fixed this by installing merlin-core in the docs tox environment.

Note: When I generate the docs now, I see some import warnings for other packages. However, I opted to ignore those for now because I was having trouble installing one of them (cudf) into the environment, and it didn't prevent the docs from generating.

I've also included a couple of small README changes:

  • Fixed a typo
  • Added a note about using Python 3.9 to generate documentation

Copy link
Member

@mikemckiernan mikemckiernan left a 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.

tox.ini Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@rnyak rnyak added this to the Merlin 23.03 milestone Mar 20, 2023
@@ -79,6 +79,7 @@ commands =
changedir = {toxinidir}
deps = -rrequirements/docs.txt
commands =
python -m pip install .
Copy link
Member

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

Copy link
Contributor Author

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.

@karlhigley karlhigley merged commit 259ee00 into main Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants