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

CornerPlotter broken API fixed for web pages #346

Merged
merged 20 commits into from
Nov 13, 2023

Conversation

thjsal
Copy link
Contributor

@thjsal thjsal commented Nov 10, 2023

As mentioned in issue #306 the CornerPlotter API has not been showing up in the documentation pages for a while. That is now fixed by installing getdist and nestcheck in the GitHub Action that builds the documentation pages. Apparently, those packages were required for CornerPlotter to appear in the documentation.

I only fixed this for the Python3 web pages. For Python2 pages the installation of getdist and nestcheck did not seem to work with same command, and I did not spend time checking alternative ways to do that. Having the full API only in the Python3 pages is probably still ok.

@thjsal thjsal linked an issue Nov 10, 2023 that may be closed by this pull request
@thjsal thjsal linked an issue Nov 10, 2023 that may be closed by this pull request
@thjsal thjsal requested a review from sguillot November 10, 2023 23:22
@thjsal thjsal added the documentation Improvements or additions to documentation label Nov 10, 2023
@thjsal
Copy link
Contributor Author

thjsal commented Nov 10, 2023

I already manually ran the documentation building and page deployment from the new branch, so, therefore, the web pages already show now the CornerPlotter API correctly. Only thing that I don't know is why only some functions and their docstrings are shown for that class. But that is maybe determined somewhere.

@drannawatts drannawatts self-requested a review November 13, 2023 13:50
Copy link
Member

@drannawatts drannawatts left a comment

Choose a reason for hiding this comment

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

Approved....

@thjsal thjsal merged commit 1dfb38f into main Nov 13, 2023
5 checks passed
@thjsal thjsal deleted the api-for-cornerplotter-broken-in-github branch November 27, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

No API for CornerPlotter showing on documentation page
2 participants