-
Notifications
You must be signed in to change notification settings - Fork 222
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
Docstring updates, guide improvements. #915
Conversation
Hi @cpfiffer, the document will only be automatically built on the master branch or on a commit tagged with a Only allowing master-branch or release tag building could prevent docs in a not-yet-approved commit being published. If you want to preview the update, you can build it on the local machine by run
The point the browser to http://localhost:8080/dev/ to preview the updates. After the docs being merged into the master branch, it will be automatically built and published. |
The CI job is triggered, but there's an error. I will check it ASAP. |
It doesn't seem that the update of the webpage actually worked, e.g. Library is still called Library instead of API as changed by Cameron through this PR. I suppose something went wrong. |
Side question: Why do we need |
We require |
Which docstring requires this? Would it make sense to get rid of it? It feels wrong that our documentation build depends on DynamicHMC. But maybe thats just me. |
Well, ignore me, I guess. I was referring to this docstring
but we don't appear to be exporting it to the website, so the documentation build step probably doesn't need to include DynamicHMC. Unless we want to export the docstring. |
Adds some meager docstrings for the distributions we have, and tacks them onto the API page. I've also changed the name from Library to API for the page that shows off our docstrings.
It doesn't really seem like the docs are being built automatically -- @KDr2 do you know what's up with that?