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.

Sign up for GitHub

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

Jump to bottom

Update notebooks to integrate them more easily in doc #119

Merged
merged 1 commit into from
Nov 25, 2021
Merged

Update notebooks to integrate them more easily in doc #119

merged 1 commit into from
Nov 25, 2021

Conversation

nhuet
Copy link
Contributor

@nhuet nhuet commented Nov 22, 2021

  • rename and number notebooks using 2 digits to ease sorting them,
    we let the 00-09 numbers for quick start notebooks which will be the
    ones previously generated from python scripts in examples
  • scheduling notebook:
    • move main title and description in first cell (for auto-extraction
      by autodoc.py)
    • remove commented cell
    • add a level to all titles (by adding a #)
      so that only the main title is a html H1
    • bonus: when using the toc from jupyter nbextensions,
      the title will not be numbered (as a H1) and the other
      section titles will be well numbered

@nhuet nhuet mentioned this pull request Nov 22, 2021
Merged
@neo-alex
Copy link
Collaborator

OK to merge, thanks

@dbarbier
Copy link
Contributor

You made changes in scheduling notebook, please provide a link to binder to help reviewers.

@nhuet
Copy link
Contributor Author

nhuet commented Nov 23, 2021

  • scheduling notebook for this PR: Binder
  • scheduling notebok from master Binder

dbarbier
dbarbier approved these changes Nov 23, 2021
View reviewed changes
Copy link
Contributor

@dbarbier dbarbier 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 much better indeed with this PR.

@nhuet
Update notebooks to integrate them more easily in doc
605d20a 
- rename and number notebooks using 2 digits to ease sorting them,
  we let the 00-09 numbers for quick start notebooks which will be the
  ones  previously generated from python scripts in examples
- scheduling notebook:
  - move main title and description in first cell (for auto-extraction
    by autodoc.py)
  - remove commented cell
  - add a level to all titles (by adding a #)
    so that only the main title is a html H1
  - bonus: when using the toc from jupyter nbextensions,
    the title will not be numbered (as a H1) and the other
    section titles will be well numbered
@nhuet nhuet force-pushed the nh/notebooks_modif_for_integration branch from d0a9d44 to 605d20a Compare November 25, 2021 09:00
@galleon galleon merged commit aaee106 into airbus:master Nov 25, 2021
@nhuet nhuet deleted the nh/notebooks_modif_for_integration branch November 26, 2021 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbarbier dbarbier dbarbier approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nhuet @neo-alex @dbarbier @galleon