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

autodoc: fix notebooks download links + other improvements #49

Merged
merged 2 commits into from
Sep 3, 2021

Conversation

nhuet
Copy link
Contributor

@nhuet nhuet commented Aug 26, 2021

  • fix notebook download links
  • notebooks generation: add a title cell and allow magic commands
    ex:
      # %%
      # %matplotlib
    
    transforms into a code cell with magic command %matplotlib
  • do not version files autogenerated by autodoc.py
  • create subdirectories like docs/reference when missing (e.g. at first doc build)
  • the script can be now launched also from main directory

@nhuet nhuet force-pushed the autodoc branch 2 times, most recently from 2915bbf to 4dd98b2 Compare August 26, 2021 09:04
nhuet added 2 commits August 31, 2021 10:06
- fix  notebook download links
- notebooks generation: add a title cell and allow magic commands
  ex:
    # %%
    # %matplotlib
  transforms into a code cell with magic command `%matplotlib` 
- create subdirectories like dopcs/reference when missing (e.g. at first doc build)
- script works also from main directory
Copy link
Collaborator

@neo-alex neo-alex left a comment

Choose a reason for hiding this comment

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

Seems all good to me, thanks!

@galleon galleon merged commit 9625fb1 into airbus:master Sep 3, 2021
@nhuet nhuet deleted the autodoc branch September 14, 2021 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants