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

Documentation for Parallel Tempering is not properly generated #620

Closed
yihengwuKP opened this issue Aug 23, 2022 · 6 comments
Closed

Documentation for Parallel Tempering is not properly generated #620

yihengwuKP opened this issue Aug 23, 2022 · 6 comments

Comments

@yihengwuKP
Copy link

I recently notice that the documentation for parallel tempering is empty but the docstring is present in the code. Presumably the workflow of the generation of the documentation is broken somewhere?

@mikemhenry
Copy link
Contributor

Thank you for pointing this out @yihengwuKP we are probably missing a call to autodoc somewhere. We will look into it!

@jchodera
Copy link
Member

Thanks for catching this! None of the multistate samplers have their API docs being rendered.

I believe this can happen when the module cannot be imported in the sphinx build environment. It's possible our required dependencies changed but the sphinx dependency list was not updated.

@yihengwuKP
Copy link
Author

Cool, thanks for your quick responses!

@mikemhenry mikemhenry mentioned this issue Sep 1, 2022
5 tasks
@mikemhenry
Copy link
Contributor

Resolved with #622

@mikemhenry
Copy link
Contributor

Note you will have to select "latest" for the docs to render, since the most recent stable version is broken, but will be fixed on next release.

@yihengwuKP
Copy link
Author

cool, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants