[#995] added instructions for pulling main into dev branch

[joehiggi1758]

Pull Request Checklist

Below is a simple checklist but please do not hesitate to ask for assistance!

• Fork, clone, and checkout the newest version of the code
• Create a new branch
• Make necessary code changes
• Install black (i.e., python -m pip install black or conda install -c conda-forge black)
• Install flake8 (i.e., python -m pip install flake8 or conda install -c conda-forge flake8)
• Install pytest-cov (i.e., python -m pip install pytest-cov or conda install -c conda-forge pytest-cov)
• Run black --exclude=".*\.ipynb" --extend-exclude=".venv" --diff ./ in the root stumpy directory
• Run flake8 --extend-exclude=.venv ./ in the root stumpy directory
• Run ./setup.sh dev && ./test.sh in the root stumpy directory
• Reference a Github issue (and create one if one doesn't already exist)

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.33%. Comparing base (e271570) to head (bcf2604).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1028      +/-   ##
==========================================
+ Coverage   97.32%   97.33%   +0.01%     
==========================================
  Files          89       89              
  Lines       14964    15027      +63     
==========================================
+ Hits        14563    14626      +63     
  Misses        401      401              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[joehiggi1758]

@seanlaw I did my best here but couldn't quite get the drop down rendering as expected with 'myst-nb' any tips?

[seanlaw]

@joehiggi1758 Let me take a look

[seanlaw]

According to the top of this page, it says:

This uses the sphinx-togglebutton package to add a little button that toggles the visibility of content

So, I'm guessing that we'll need to add the sphinx-togglebutton package to the docs/requirements.txt in order for things to render properly:

https://sphinx-togglebutton.readthedocs.io/en/latest/index.html#installation

Would you mind trying that and seeing if it changes anything?

[joehiggi1758]

@seanlaw yes thank you for the direction - I got it working!

• I updated the requirements.txt file to contain spynx-togglebutton
• I also had to update the Conf.py file to contain sphinx_togglebutton as an extension

[seanlaw]

@seanlaw yes thank you for the direction - I got it working!

• I updated the requirements.txt file to contain spynx-togglebutton

• I also had to update the Conf.py file to contain sphinx_togglebutton as an extension

Sorry that I missed this. In the future, rather than editing the existing comment, it would be helpful to start a new comment instead. This way, I get an email that something has changed and needs my attention. This will ensure that you will receive much timelier responses.

I will try to review this ASAP.

[joehiggi1758]

@seanlaw apologies - I'll do that next time, thanks for the understanding and direction here!

[seanlaw]

@joehiggi1758 I think that the admonition should be like:

:::{admonition} Instructions for Pulling Main into a Development Branch
:class: toggle
1. First Point
2. Second Point
   * Sub point

```
Some code
Some more code
```
:::

Specifically, you want to start/stop the admonition using triple colons and then this will allow you to actually have a proper code block using triple backticks. Otherwise, the "code" part, which is just what the command line prints out, doesn't look right.

[seanlaw]

@joehiggi1758 Thank you for adding this!

[joehiggi1758]

@seanlaw my pleasure - as always, thank you for the opportunity and direction!