Skip to content

Conversation

@shaneahmed
Copy link
Member

@shaneahmed shaneahmed commented Aug 30, 2022

  • Remove nbsphinx and replace it with myst-nb.
  • Replace Example gallery with examples/README.md.
  • Remove repetitive jupyter notebook cells from docs.
  • Hide outputs related to progress bar.
  • Remove nbsphinx from requirements.
  • Add myst-nb in requirements.

https://tia-toolbox.readthedocs.io/en/dev-doc-use-myst-nb/

- Remove nbsphinx and replace it with myst-nb.
@codecov
Copy link

codecov bot commented Aug 30, 2022

Codecov Report

Merging #454 (8bc6f8d) into develop (d938763) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #454   +/-   ##
========================================
  Coverage    99.64%   99.64%           
========================================
  Files           61       61           
  Lines         5926     5926           
  Branches       980      980           
========================================
  Hits          5905     5905           
  Misses           9        9           
  Partials        12       12           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

- Remove nbsphinx from notebook 05.
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

- Comment all notebooks except full pipeline for test.
- Set myst_commonmark_only to True.
@shaneahmed shaneahmed changed the title [SKIP CI] DEV: Remove nbsphinx and replace it with myst-nb. [skip ci] DEV: Remove nbsphinx and replace it with myst-nb. Aug 30, 2022
@shaneahmed shaneahmed added the documentation Improvements or additions to documentation label Sep 1, 2022
- Change html theme to furo.
# Conflicts:
#	docs/requirements.txt
#	requirements.dev.conda.yml
#	requirements.txt
#	requirements_dev.txt
- Rename readme.md to readme.rst.
- Remove css file from setup.
shaneahmed and others added 10 commits September 23, 2022 10:18
- Fix conf.py comment.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update WSL2 recommendation in installation.rst.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update badges in README.md.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update center alignment.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Add copy button to docs.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Remove epub.

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update citation

Signed-off-by: Shan E Ahmed Raza <[email protected]>
shaneahmed and others added 10 commits September 27, 2022 10:58
# Conflicts:
#	examples/09-multi-task-segmentation.ipynb
- Update 09-multi-task-segmentation.ipynb
- Update 09-multi-task-segmentation.ipynb for myst-nb
- Update 09-multi-task-segmentation.ipynb for myst-nb
- Update 09-multi-task-segmentation.ipynb for myst-nb
- Update scikit-learn for slide-graph

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- scikit-learn >1.02 not compatible with python 3.7

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update inference-pipelines/slide-graph.ipynb

Signed-off-by: Shan E Ahmed Raza <[email protected]>
@shaneahmed
Copy link
Member Author

@John-P This PR is now ready for final checks.

- Update inference-pipelines/slide-graph.ipynb

Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update inference-pipelines/slide-graph.ipynb

Signed-off-by: Shan E Ahmed Raza <[email protected]>
Copy link
Contributor

@John-P John-P left a comment

Choose a reason for hiding this comment

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

These changes look great and work really well with the new theme.

@shaneahmed shaneahmed merged commit 39af08a into develop Oct 10, 2022
@shaneahmed shaneahmed deleted the dev-doc-use-myst-nb branch October 10, 2022 17:43
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.

Problems with Colab in Jupyter Notebooks Read the Docs Rendering of Jupyter Notebook Markdown Cells is Incorrect

5 participants