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

Add Jupyter Book #2875

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Conversation

atharva-2001
Copy link
Member

📝 Description

Type: 🪲 bugfix | 🚀 feature | ☣️ breaking change | 🚦 testing | 📝 documentation | 🎢 infrastructure

This is a work in progress pull request that adds configuration for JupyterBook based documentation.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@tardis-bot
Copy link
Contributor

tardis-bot commented Nov 12, 2024

*beep* *bop*
Hi human,
I ran ruff on the latest commit (fc944c4).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

4	E999	[ ] SyntaxError: Expected an expression
2	W292	[*] No newline at end of file
1	W293	[*] Blank line contains whitespace

Complete output(might be large):

.github/workflows/jupyterbook.yml:1:13: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
.github/workflows/jupyterbook.yml:56:1: W293 [*] Blank line contains whitespace
docs/_config.yml:4:15: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
docs/_config.yml:47:135: W292 [*] No newline at end of file
docs/_toc.yml:3:7: E999 SyntaxError: Expected an expression
docs/_toc.yml:38:36: W292 [*] No newline at end of file
docs/api.rst:1:5: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
Found 7 errors.
[*] 3 fixable with the `--fix` option.

@atharva-2001 atharva-2001 changed the title Add Jupyter Book Add Jupyter Book with Panel Nov 12, 2024
@atharva-2001 atharva-2001 changed the title Add Jupyter Book with Panel Add Jupyter Book Nov 12, 2024
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.87%. Comparing base (763c11d) to head (fc944c4).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2875      +/-   ##
==========================================
- Coverage   70.22%   69.87%   -0.36%     
==========================================
  Files         214      214              
  Lines       15981    15981              
==========================================
- Hits        11223    11166      -57     
- Misses       4758     4815      +57     

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants