Skip to content

Sphinx update requirement and include references#68

Merged
ozgesurer merged 6 commits intov0.2-stagingfrom
include-use-cases
Sep 11, 2023
Merged

Sphinx update requirement and include references#68
ozgesurer merged 6 commits intov0.2-stagingfrom
include-use-cases

Conversation

@mosesyhc
Copy link
Copy Markdown
Member

@mosesyhc mosesyhc commented Sep 9, 2023

I made a draft section under use cases for a bibliography of references that use surmise. Feel free to edit.

@mosesyhc
Copy link
Copy Markdown
Member Author

mosesyhc commented Sep 9, 2023

Requires manual make html though.
Make sure sphinx>=7.2 and sphinx-rtd-theme is installed.

@mosesyhc mosesyhc requested review from ozgesurer and wildsm and removed request for ozgesurer September 9, 2023 18:41
@mosesyhc mosesyhc linked an issue Sep 9, 2023 that may be closed by this pull request
3 tasks
@mosesyhc mosesyhc added the documentation Improvements or additions to documentation label Sep 9, 2023
@mosesyhc mosesyhc requested a review from ozgesurer September 9, 2023 18:44
Copy link
Copy Markdown
Contributor

@wildsm wildsm left a comment

Choose a reason for hiding this comment

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

Thanks, looks fine to me

@mosesyhc
Copy link
Copy Markdown
Member Author

@ozgesurer: I want to make sure nothing obvious is missing in the bibliography. That'd be all we need to review.

@ozgesurer
Copy link
Copy Markdown
Collaborator

Sure @mosesyhc. I will take a look at it tonight, if not, tomorrow. Sorry, I needed to take care of some personal stuff this weekend, and I'm running behind.

@mosesyhc
Copy link
Copy Markdown
Member Author

@ozgesurer Tomorrow or Tuesday is fine. Today is Sunday 🙂

@ozgesurer
Copy link
Copy Markdown
Collaborator

@mosesyhc I am not able to find the bibliography of references that use surmise under use cases. Do you think that you push the associated changes to this PR?

@mosesyhc
Copy link
Copy Markdown
Member Author

mosesyhc commented Sep 11, 2023

@ozgesurer: Check this .bib file for the references. The documentation html is not updated unless make is run manually, or readthedocs runs make.

https://github.com/surmising/surmise/blob/include-use-cases/docs/surmise.bib

@ozgesurer ozgesurer merged commit fe21fd1 into v0.2-staging Sep 11, 2023
@ozgesurer
Copy link
Copy Markdown
Collaborator

I got it. Everything looks great. Merging...

@mosesyhc mosesyhc deleted the include-use-cases branch September 12, 2023 15:31
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.

Documentation review and update for v0.2

3 participants